diff --git a/CHANGES.md b/CHANGES.md index 3873e66b..db4752e5 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -6,7 +6,7 @@ Apollo Java 2.5.0 ------------------ -* +* [Feature Provide a new open APl to return the organization list](https://github.com/apolloconfig/apollo-java/pull/102) ------------------ All issues and pull requests are [here](https://github.com/apolloconfig/apollo-java/milestone/5?closed=1) diff --git a/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/api/OrganizationOpenApiService.java b/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/api/OrganizationOpenApiService.java new file mode 100644 index 00000000..8dcd3bcf --- /dev/null +++ b/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/api/OrganizationOpenApiService.java @@ -0,0 +1,30 @@ +/* + * Copyright 2024 Apollo Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.ctrip.framework.apollo.openapi.api; + +import com.ctrip.framework.apollo.openapi.dto.OpenOrganizationDto; + +import java.util.List; + +public interface OrganizationOpenApiService { + + /** + * Retrieves all organizations + * @since 2.5.0 + */ + List getOrganizations(); +} diff --git a/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/client/ApolloOpenApiClient.java b/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/client/ApolloOpenApiClient.java index 8a8ccb74..71084c9a 100644 --- a/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/client/ApolloOpenApiClient.java +++ b/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/client/ApolloOpenApiClient.java @@ -22,6 +22,7 @@ import com.ctrip.framework.apollo.openapi.client.service.ItemOpenApiService; import com.ctrip.framework.apollo.openapi.client.service.NamespaceOpenApiService; import com.ctrip.framework.apollo.openapi.client.service.ReleaseOpenApiService; +import com.ctrip.framework.apollo.openapi.client.service.OrganizationOpenApiService; import com.ctrip.framework.apollo.openapi.dto.*; import com.google.common.base.Preconditions; import com.google.common.base.Strings; @@ -45,6 +46,7 @@ public class ApolloOpenApiClient { private final String portalUrl; private final String token; private final AppOpenApiService appService; + private final OrganizationOpenApiService organizationOpenService; private final ItemOpenApiService itemService; private final ReleaseOpenApiService releaseService; private final NamespaceOpenApiService namespaceService; @@ -63,6 +65,7 @@ private ApolloOpenApiClient(String portalUrl, String token, RequestConfig reques namespaceService = new NamespaceOpenApiService(client, baseUrl, GSON); itemService = new ItemOpenApiService(client, baseUrl, GSON); releaseService = new ReleaseOpenApiService(client, baseUrl, GSON); + organizationOpenService = new OrganizationOpenApiService(client, baseUrl, GSON); } public void createApp(OpenCreateAppDTO req) { @@ -83,6 +86,13 @@ public List getAllApps() { return appService.getAllApps(); } + /** + * Get all organizations + */ + public List getOrganizations() { + return organizationOpenService.getOrganizations(); + } + /** * Get applications which can be operated by current open api client. * diff --git a/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/client/service/OrganizationOpenApiService.java b/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/client/service/OrganizationOpenApiService.java new file mode 100644 index 00000000..6d151abe --- /dev/null +++ b/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/client/service/OrganizationOpenApiService.java @@ -0,0 +1,51 @@ +/* + * Copyright 2024 Apollo Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.ctrip.framework.apollo.openapi.client.service; + +import com.ctrip.framework.apollo.openapi.client.url.OpenApiPathBuilder; +import com.ctrip.framework.apollo.openapi.dto.OpenOrganizationDto; +import com.google.gson.Gson; +import com.google.gson.reflect.TypeToken; +import org.apache.http.client.methods.CloseableHttpResponse; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.util.EntityUtils; +import java.lang.reflect.Type; +import java.util.List; + +public class OrganizationOpenApiService extends AbstractOpenApiService implements + com.ctrip.framework.apollo.openapi.api.OrganizationOpenApiService{ + private static final Type ORGANIZATIONS_DTO_LIST_TYPE = new TypeToken>() { + }.getType(); + + public OrganizationOpenApiService(CloseableHttpClient client, String baseUrl, Gson gson) { + super(client, baseUrl, gson); + } + + @Override + public List getOrganizations() { + OpenApiPathBuilder pathBuilder = OpenApiPathBuilder.newBuilder() + .customResource("/organizations"); + + try (CloseableHttpResponse response = get(pathBuilder)) { + return gson.fromJson(EntityUtils.toString(response.getEntity()), ORGANIZATIONS_DTO_LIST_TYPE); + } catch (Throwable ex) { + throw new RuntimeException("get organizations information failed", ex); + } + + } +} + diff --git a/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/dto/OpenOrganizationDto.java b/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/dto/OpenOrganizationDto.java new file mode 100644 index 00000000..94e07a79 --- /dev/null +++ b/apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/dto/OpenOrganizationDto.java @@ -0,0 +1,46 @@ +/* + * Copyright 2024 Apollo Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.ctrip.framework.apollo.openapi.dto; + +public class OpenOrganizationDto { + private String orgId; + private String orgName; + + public String getOrgId() { + return orgId; + } + + public void setOrgId(String orgId) { + this.orgId = orgId; + } + + public String getOrgName() { + return orgName; + } + + public void setOrgName(String orgName) { + this.orgName = orgName; + } + + @Override + public String toString() { + return "OpenOrganizationDto{" + + "orgId='" + orgId + '\'' + + ", orgName='" + orgName + '\'' + + '}'; + } +} \ No newline at end of file