public class EndpointAdminClient extends Object
Modifier and Type | Field and Description |
---|---|
static int |
ENDPOINT_PER_PAGE |
Constructor and Description |
---|
EndpointAdminClient(String cookie,
String backendServerURL,
org.apache.axis2.context.ConfigurationContext configCtx) |
Modifier and Type | Method and Description |
---|---|
void |
addDynamicEndpoint(String key,
String epName)
Add an endpoint to the Synapse registry
|
void |
addEndpoint(String endpointString)
Add an Endpoint described by the given configuration
|
void |
deleteAllEndpointGroups()
Delete all endpoints in the synapse configuration
|
void |
deleteDynamicEndpoint(String key)
Delete an endpoint from the registry
|
void |
deleteEndpoint(String epName)
Delete an endpoint from the synapse configuration
|
void |
deleteSelectedEndpoints(String[] epNames)
Delete selected endpoints from synapse configuration
|
void |
disableStatistics(String name)
Stop collecting statistics for a specified endpoint
|
void |
enableStatistics(String name)
Enable statistics collection for the specified endpoint
|
org.wso2.carbon.endpoint.stub.types.common.ConfigurationObject[] |
getDependents(String epName)
Get dependents of a particular endpoint.
|
String |
getDynamicEndpoint(String key)
Get a dynamic endpoint from the registry
|
int |
getDynamicEndpointCount()
Get the dynamic endpoint count
|
String[] |
getDynamicEndpoints(int pageNumber,
int endpointsPerPage)
Get all endpoints stored in the registry
|
String[] |
getDynamicEndpointsSearch(int pageNumber,
int endpointsPerPage,
String searchText)
Get Metadata of all the Searched Dynamic Endpoints in the Synapse configuration
|
String |
getEndpoint(String epName)
Gets the endpoint element as a string
|
int |
getEndpointCount()
Get the endpoint count
|
org.wso2.carbon.endpoint.stub.types.service.EndpointMetaData[] |
getEndpointMetaData(int pageNumber,
int endpointsPerPage)
Get Metadata of all the Endpoints in the Synapse configuration
|
org.wso2.carbon.endpoint.stub.types.service.EndpointMetaData[] |
getEndpointMetaDataSearch(int pageNumber,
int endpointsPerPage,
String searchText)
Get Metadata of all the Searched Endpoints in the Synapse configuration
|
String[] |
getEndpoints()
Get all endpoint configurations from the synapse configuration
|
EndpointService |
getEndpointService(org.wso2.carbon.endpoint.stub.types.service.EndpointMetaData metaData)
Get the endpoint service for the given endpoint metadata
|
EndpointService |
getEndpointService(String endpointString)
Get the endpoint service for the given endpoint configuration
|
boolean |
isRegisterNull()
check the registry
|
void |
saveDynamicEndpoint(String key,
String epName)
Save an endpoint to the Synapse registry
|
void |
saveEndpoint(String epName)
Save an endpoint
|
void |
switchOff(String name)
Switch off Endpoint given by the name
|
void |
switchOn(String name)
Set Endpoint status to Active
|
void |
updateDynamicEndpoint(String key,
String epConfiguration)
Update an existing dynamic endpoint
|
public static final int ENDPOINT_PER_PAGE
public void addEndpoint(String endpointString) throws Exception
endpointString
- - configuration representing the endpoint that needs
to be addedException
- in case of an errorpublic void switchOn(String name) throws Exception
name
- name of the endpointException
- in case of an errorpublic void switchOff(String name) throws Exception
name
- name of the endpointException
- in case of an errorpublic void deleteEndpoint(String epName) throws Exception
epName
- endpoint nameException
- in case of an errorpublic void deleteSelectedEndpoints(String[] epNames) throws Exception
epNames
- Exception
public void deleteAllEndpointGroups() throws Exception
Exception
public void deleteDynamicEndpoint(String key) throws Exception
key
- key of the dynamic endpointException
- in case of an errorpublic org.wso2.carbon.endpoint.stub.types.common.ConfigurationObject[] getDependents(String epName) throws Exception
epName
- endpoint nameException
public void updateDynamicEndpoint(String key, String epConfiguration) throws Exception
key
- dynamic endpoint keyepConfiguration
- new endpoint configurationException
- in case of an errorpublic String getEndpoint(String epName) throws Exception
epName
- - name of the endpointException
- in case of an errorpublic String[] getEndpoints() throws Exception
Exception
- in case of an errorpublic String getDynamicEndpoint(String key) throws Exception
key
- dynamic endpoint keyException
- on an errorpublic String[] getDynamicEndpoints(int pageNumber, int endpointsPerPage) throws Exception
pageNumber
- page numberendpointsPerPage
- no of endpoints per pageException
- in case of an errorpublic String[] getDynamicEndpointsSearch(int pageNumber, int endpointsPerPage, String searchText) throws Exception
pageNumber
- endpointsPerPage
- searchText
- Exception
public EndpointService getEndpointService(org.wso2.carbon.endpoint.stub.types.service.EndpointMetaData metaData) throws XMLStreamException
metaData
- Metadata of an endpointXMLStreamException
- in case of an errorpublic EndpointService getEndpointService(String endpointString) throws XMLStreamException
endpointString
- configuration of the endpointXMLStreamException
- in case of an errorpublic org.wso2.carbon.endpoint.stub.types.service.EndpointMetaData[] getEndpointMetaData(int pageNumber, int endpointsPerPage) throws Exception
pageNumber
- page numberendpointsPerPage
- no of endpoints per pageException
- in case of an errorpublic org.wso2.carbon.endpoint.stub.types.service.EndpointMetaData[] getEndpointMetaDataSearch(int pageNumber, int endpointsPerPage, String searchText) throws Exception
pageNumber
- endpointsPerPage
- searchText
- Exception
public void enableStatistics(String name) throws Exception
name
- name of the endpointException
- in case of an errorpublic void disableStatistics(String name) throws Exception
name
- name of the endpointException
- in case of an errorpublic void addDynamicEndpoint(String key, String epName) throws Exception
key
- of the dynamic endpointepName
- endpoint nameException
- in case of an errorpublic void saveDynamicEndpoint(String key, String epName) throws Exception
key
- dynamic endpoint keyepName
- endpoint nameException
- in case of an errorpublic void saveEndpoint(String epName) throws Exception
epName
- endpoint nameException
- in case of an errorpublic int getEndpointCount() throws Exception
Exception
public int getDynamicEndpointCount() throws Exception
Exception
Copyright © 2022 WSO2. All rights reserved.