public class EndpointAdmin
extends org.wso2.carbon.mediation.initializer.AbstractServiceBusAdmin
| Modifier and Type | Field and Description |
|---|---|
static String |
WSO2_ENDPOINT_MEDIA_TYPE |
| Constructor and Description |
|---|
EndpointAdmin() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
addDynamicEndpoint(String key,
String epConfiguration)
Add an endpoint to the Synapse registry
|
boolean |
addEndpoint(String epString)
Add an Endpoint described by the given configuration
|
boolean |
addEndpointForTenant(String endpointData,
String tenantDomain)
Set the tenant domain when a publisher publishes his API in MT mode.
|
void |
deleteAllEndpointGroups()
Delete
|
boolean |
deleteDynamicEndpoint(String key)
Remove a endpoint form the registry
|
boolean |
deleteEndpoint(String endpointName)
Deletes the endpoint from the SynapseConfiguration
|
boolean |
deleteEndpointForTenant(String endpointName,
String tenantDomain)
Set the tenant domain when a publisher publishes his API in MT mode.
|
void |
deleteSelectedEndpoint(String[] endpointNames)
Delete selected endpoints
|
void |
disableStatistics(String endpointName)
Stop collecting statistics for a specified endpoint
|
void |
enableStatistics(String endpointName)
Enable statistics collection for the specified endpoint
|
org.wso2.carbon.mediation.dependency.mgt.ConfigurationObject[] |
getDependents(String endpointName)
Get dependents of a particular endpoint.
|
String |
getDynamicEndpoint(String key)
Get a dynamic endpoint from the registry
|
int |
getDynamicEndpointCount() |
String[] |
getDynamicEndpoints()
Get all endpoints stored in the registry
|
String |
getEndpointConfiguration(String endpointName)
Gets the endpoint element as a string
|
int |
getEndpointCount() |
String[] |
getEndpoints()
Get all endpoint configurations from the synapse configuration
|
EndpointMetaData[] |
getEndpointsData()
Get Metadata of all Endpoints of Synapse configuration
|
String[] |
getEndPointsNames() |
String[] |
getEndPointsNamesForTenant(String tenantDomain)
Set the tenant domain when a publisher publishes his API in MT mode.
|
boolean |
isRegisterNull()
Check registry is available or not
|
boolean |
saveDynamicEndpoint(String key,
String epName)
Update an existing Endpoint endpoint in the registry
|
boolean |
saveEndpoint(String epString)
Update an existing endpoint from the given String representation of the XML
|
void |
switchOff(String endpointName)
Switch off Endpoint
|
void |
switchOn(String endpointName)
Set Endpoint status to Active
|
getLock, getMediationPersistenceManager, getServerConfigurationInformation, getServerContextInformation, getSynapseConfiguration, getSynapseEnvironment, getSynapseEnvironment, lockSynapseConfiguration, unlockSynapseConfigurationgetAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUsername, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamppublic static final String WSO2_ENDPOINT_MEDIA_TYPE
public void switchOn(String endpointName) throws EndpointAdminException
endpointName - name of the endpointEndpointAdminException - in case of an errorpublic void switchOff(String endpointName) throws EndpointAdminException
endpointName - name of the endpointEndpointAdminException - in case of an errorpublic boolean addEndpoint(String epString) throws EndpointAdminException
epString - - configuration representing the endpoint that needs
to be addedEndpointAdminException - if the element is not an endpoint or if an endpoint
with the same name existspublic boolean addEndpointForTenant(String endpointData, String tenantDomain) throws EndpointAdminException
endpointData - Endpoint file contenttenantDomain - Domain of the logged tenantEndpointAdminException - Thrown if an error occurpublic boolean deleteEndpointForTenant(String endpointName, String tenantDomain) throws EndpointAdminException
endpointName - Name of the endpoint file to be deletedtenantDomain - Domain of the logged tenantEndpointAdminException - Thrown if an error occurpublic String[] getEndPointsNamesForTenant(String tenantDomain) throws EndpointAdminException
tenantDomain - Domain of the logged tenantEndpointAdminException - Thrown if an error occurspublic boolean deleteEndpoint(String endpointName) throws EndpointAdminException
endpointName - - name of the endpoint to be deletedEndpointAdminException - if the proxy service name given is not existent in the
synapse configurationpublic void deleteSelectedEndpoint(String[] endpointNames) throws EndpointAdminException
endpointNames - EndpointAdminExceptionpublic void deleteAllEndpointGroups()
throws EndpointAdminException
EndpointAdminExceptionpublic String getEndpointConfiguration(String endpointName) throws EndpointAdminException
endpointName - - name of the endpointException - in case of an errorEndpointAdminExceptionpublic String[] getEndpoints() throws EndpointAdminException
EndpointAdminException - in case of an errorpublic EndpointMetaData[] getEndpointsData()
public void enableStatistics(String endpointName) throws EndpointAdminException
endpointName - name of the endpointEndpointAdminException - in case of an errorpublic void disableStatistics(String endpointName) throws EndpointAdminException
endpointName - name of the endpointEndpointAdminException - on errorpublic boolean saveEndpoint(String epString) throws EndpointAdminException
epString - - String representing the XML which describes the
Endpoint elementEndpointAdminException - if the endpoint does not exists in the
SynapseConfigurationpublic boolean saveDynamicEndpoint(String key, String epName) throws EndpointAdminException
key - dynamic endpoint keyepName - endpoint nameEndpointAdminException - on Errorpublic boolean addDynamicEndpoint(String key, String epConfiguration) throws EndpointAdminException
key - of the dynamic endpointepConfiguration - endpoint configurationEndpointAdminException - in case of an errorpublic String getDynamicEndpoint(String key) throws EndpointAdminException
key - dynamic endpoint keyEndpointAdminException - on an errorpublic boolean isRegisterNull()
throws EndpointAdminException
EndpointAdminExceptionpublic String[] getDynamicEndpoints() throws EndpointAdminException
EndpointAdminException - in case of an errorpublic boolean deleteDynamicEndpoint(String key) throws EndpointAdminException
key - dynamic endpoint keyEndpointAdminException - in case of an errorpublic org.wso2.carbon.mediation.dependency.mgt.ConfigurationObject[] getDependents(String endpointName)
endpointName - endpoint namepublic String[] getEndPointsNames() throws EndpointAdminException
EndpointAdminExceptionpublic int getEndpointCount()
throws EndpointAdminException
EndpointAdminExceptionpublic int getDynamicEndpointCount()
throws EndpointAdminException
EndpointAdminExceptionCopyright © 2020 WSO2. All rights reserved.