com.ctrip.framework.apollo.openapi.client

Class ApolloOpenApiClient

java.lang.Object

com.ctrip.framework.apollo.openapi.client.ApolloOpenApiClient

public class ApolloOpenApiClient
extends Object

This class contains collections of methods to access Apollo Open Api.
For more information, please refer Apollo Wiki.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApolloOpenApiClient.ApolloOpenApiClientBuilder

Method Summary

Methods

Modifier and Type	Method and Description
OpenAppNamespaceDTO	createAppNamespace(OpenAppNamespaceDTO appNamespaceDTO) Create the app namespace
OpenItemDTO	createItem(String appId, String env, String clusterName, String namespaceName, OpenItemDTO itemDTO) Add config
void	createOrUpdateItem(String appId, String env, String clusterName, String namespaceName, OpenItemDTO itemDTO) Create config if not exists or update config if already exists
List<OpenEnvClusterDTO>	getEnvClusterInfo(String appId) Get the environment and cluster information
OpenItemDTO	getItem(String appId, String env, String clusterName, String namespaceName, String key) Get config
OpenReleaseDTO	getLatestActiveRelease(String appId, String env, String clusterName, String namespaceName)
OpenNamespaceDTO	getNamespace(String appId, String env, String clusterName, String namespaceName) Get the namespace
OpenNamespaceLockDTO	getNamespaceLock(String appId, String env, String clusterName, String namespaceName) Get the namespace lock
List<OpenNamespaceDTO>	getNamespaces(String appId, String env, String clusterName) Get the namespaces
String	getPortalUrl()
String	getToken()
static ApolloOpenApiClient.ApolloOpenApiClientBuilder	newBuilder()
OpenReleaseDTO	publishNamespace(String appId, String env, String clusterName, String namespaceName, NamespaceReleaseDTO releaseDTO) publish namespace
void	removeItem(String appId, String env, String clusterName, String namespaceName, String key, String operator) Remove config
void	updateItem(String appId, String env, String clusterName, String namespaceName, OpenItemDTO itemDTO) Update config

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getEnvClusterInfo

public List<OpenEnvClusterDTO> getEnvClusterInfo(String appId)

Get the environment and cluster information

getNamespaces

public List<OpenNamespaceDTO> getNamespaces(String appId,
                                   String env,
                                   String clusterName)

Get the namespaces

getNamespace

public OpenNamespaceDTO getNamespace(String appId,
                            String env,
                            String clusterName,
                            String namespaceName)

Get the namespace

createAppNamespace

public OpenAppNamespaceDTO createAppNamespace(OpenAppNamespaceDTO appNamespaceDTO)

Create the app namespace

getNamespaceLock

public OpenNamespaceLockDTO getNamespaceLock(String appId,
                                    String env,
                                    String clusterName,
                                    String namespaceName)

Get the namespace lock

getItem

public OpenItemDTO getItem(String appId,
                  String env,
                  String clusterName,
                  String namespaceName,
                  String key)

Get config

Returns:

the item or null if not exists

Since:

1.2.0

createItem

public OpenItemDTO createItem(String appId,
                     String env,
                     String clusterName,
                     String namespaceName,
                     OpenItemDTO itemDTO)

Add config

Returns:

the created config

updateItem

public void updateItem(String appId,
              String env,
              String clusterName,
              String namespaceName,
              OpenItemDTO itemDTO)

Update config

createOrUpdateItem

public void createOrUpdateItem(String appId,
                      String env,
                      String clusterName,
                      String namespaceName,
                      OpenItemDTO itemDTO)

Create config if not exists or update config if already exists

removeItem

public void removeItem(String appId,
              String env,
              String clusterName,
              String namespaceName,
              String key,
              String operator)

Remove config

Parameters:

operator - the user who removes the item

publishNamespace

public OpenReleaseDTO publishNamespace(String appId,
                              String env,
                              String clusterName,
                              String namespaceName,
                              NamespaceReleaseDTO releaseDTO)

publish namespace

Returns:

the released configurations

getLatestActiveRelease

public OpenReleaseDTO getLatestActiveRelease(String appId,
                                    String env,
                                    String clusterName,
                                    String namespaceName)

Returns:

the latest active release information or null if not found

getPortalUrl

public String getPortalUrl()

getToken

public String getToken()

newBuilder

public static ApolloOpenApiClient.ApolloOpenApiClientBuilder newBuilder()