com.mulesoft.mule.runtime.gw.client.session

Interface ApiPlatformSession

All Known Implementing Classes:

FileSystemPlatformSession, MonitoredApiPlatformSession

public interface ApiPlatformSession

Creates a session to query ApiPlatform and abstracts the way data is retrieved from it.

Method Summary

Modifier and Type	Method and Description
ApiPlatformSession	activateEndpoint(String organizationId, String environmentId, Long apiId) Activates an endpoint in ApiPlatform.
ApiResponse	getApi(Api api) Retrieves an Api using the local data.
ApiResponse	getApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Retrieves an Api using the local data.
ApiResponse	getApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, String apiEntityTag) Retrieves an Api using the local data.
ApiClientsResponse	getApiClients(String organizationId, String environmentId, Long apiId) Retrieves Clients for a specific Api
ApiClientsResponse	getApiClients(String organizationId, String environmentId, Long apiId, String contractsEntityTag) Retrieves Clients for a specific Api
com.mulesoft.anypoint.backoff.session.SessionMetadata	metadata()

Method Detail

metadata

com.mulesoft.anypoint.backoff.session.SessionMetadata metadata()

Returns:

current's session metadata.

activateEndpoint

ApiPlatformSession activateEndpoint(String organizationId,
                                    String environmentId,
                                    Long apiId)

Activates an endpoint in ApiPlatform.

Parameters:

organizationId - String

environmentId - String

apiId - Integer

Returns:

this

getApiClients

ApiClientsResponse getApiClients(String organizationId,
                                 String environmentId,
                                 Long apiId)

Retrieves Clients for a specific Api

Parameters:

organizationId - String

environmentId - String

apiId - Integer

Returns:

an ApiClientsResponse

getApiClients

ApiClientsResponse getApiClients(String organizationId,
                                 String environmentId,
                                 Long apiId,
                                 String contractsEntityTag)

Retrieves Clients for a specific Api

Parameters:

organizationId - String

environmentId - String

apiId - Integer

contractsEntityTag - String

Returns:

an ApiClientsResponse

getApi

ApiResponse getApi(Api api)

Retrieves an Api using the local data.

Parameters:

api - Api

Returns:

an ApiResponse.

getApi

ApiResponse getApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)

Retrieves an Api using the local data.

Parameters:

apiKey - ApiKey

Returns:

an ApiResponse.

getApi

ApiResponse getApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                   String apiEntityTag)

Retrieves an Api using the local data.

Parameters:

apiKey - ApiKey

apiEntityTag - String

Returns:

an ApiResponse.