Skip to content

Commit 01e76b4

Browse files
fix AppNamespaceOpenApiService license issue
1 parent dadd33d commit 01e76b4

File tree

1 file changed

+125
-0
lines changed

1 file changed

+125
-0
lines changed
Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
/*
2+
* Copyright 2024 Apollo Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*
16+
*/
17+
package com.ctrip.framework.apollo.openapi.server.service;
18+
19+
import com.ctrip.framework.apollo.openapi.model.OpenAppNamespaceDTO;
20+
import java.util.List;
21+
22+
/**
23+
* App Namespace Open API Service
24+
*
25+
* @author apollo
26+
*/
27+
public interface AppNamespaceOpenApiService {
28+
29+
/**
30+
* 获取所有公共的 App Namespace
31+
* 公共的 app ns,能被其它项目关联到的 app ns
32+
*
33+
* @return 公共 App Namespace 列表
34+
*/
35+
List<OpenAppNamespaceDTO> findPublicAppNamespaces();
36+
37+
/**
38+
* 根据名称查找公共 App Namespace
39+
*
40+
* @param namespaceName namespace 名称
41+
* @return 公共 App Namespace,如果不存在返回 null
42+
*/
43+
OpenAppNamespaceDTO findPublicAppNamespace(String namespaceName);
44+
45+
/**
46+
* 根据 appId 和 namespace 名称查找 App Namespace
47+
*
48+
* @param appId app ID
49+
* @param namespaceName namespace 名称
50+
* @return App Namespace,如果不存在返回 null
51+
*/
52+
OpenAppNamespaceDTO findByAppIdAndName(String appId, String namespaceName);
53+
54+
/**
55+
* 根据 appId 查找所有 App Namespace
56+
*
57+
* @param appId app ID
58+
* @return App Namespace 列表
59+
*/
60+
List<OpenAppNamespaceDTO> findByAppId(String appId);
61+
62+
/**
63+
* 获取所有 App Namespace
64+
*
65+
* @return 所有 App Namespace 列表
66+
*/
67+
List<OpenAppNamespaceDTO> findAll();
68+
69+
/**
70+
* 为指定 App 创建默认的 App Namespace (application)
71+
*
72+
* @param appId app ID
73+
*/
74+
void createDefaultAppNamespace(String appId);
75+
76+
/**
77+
* 检查 App Namespace 名称是否唯一
78+
*
79+
* @param appId app ID
80+
* @param namespaceName namespace 名称
81+
* @return true 如果名称唯一,false 如果已存在
82+
*/
83+
boolean isAppNamespaceNameUnique(String appId, String namespaceName);
84+
85+
/**
86+
* 创建 App Namespace
87+
*
88+
* @param appNamespace App Namespace 信息
89+
* @return 创建成功的 App Namespace
90+
*/
91+
OpenAppNamespaceDTO createAppNamespace(OpenAppNamespaceDTO appNamespace);
92+
93+
/**
94+
* 创建 App Namespace(可指定是否添加命名空间前缀)
95+
*
96+
* @param appNamespace App Namespace 信息
97+
* @param appendNamespacePrefix 是否添加命名空间前缀
98+
* @return 创建成功的 App Namespace
99+
*/
100+
OpenAppNamespaceDTO createAppNamespace(OpenAppNamespaceDTO appNamespace, boolean appendNamespacePrefix);
101+
102+
/**
103+
* 导入 App Namespace
104+
*
105+
* @param appNamespace App Namespace 信息
106+
* @return 导入成功的 App Namespace
107+
*/
108+
OpenAppNamespaceDTO importAppNamespace(OpenAppNamespaceDTO appNamespace);
109+
110+
/**
111+
* 删除 App Namespace
112+
*
113+
* @param appId app ID
114+
* @param namespaceName namespace 名称
115+
* @return 被删除的 App Namespace
116+
*/
117+
OpenAppNamespaceDTO deleteAppNamespace(String appId, String namespaceName);
118+
119+
/**
120+
* 根据 appId 批量删除 App Namespace
121+
*
122+
* @param appId app ID
123+
*/
124+
void batchDeleteByAppId(String appId);
125+
}

0 commit comments

Comments
 (0)