Class TemplateEndpointService
- java.lang.Object
-
- org.wso2.carbon.endpoint.ui.endpoints.template.TemplateEndpointService
-
- All Implemented Interfaces:
EndpointService
public class TemplateEndpointService extends Object implements EndpointService
-
-
Constructor Summary
Constructors Constructor Description TemplateEndpointService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canAddAsChild()
Defines whether this Endpoint Type can be add as a child Endpoint of a List Endpoint like LoadBalance Endpoint.boolean
canAddAsTemplate()
Defines whether we can create a template from this Endpoint Type.String
getDescription()
Get the description of the Endpoint Type.String
getDisplayName()
This gives the display name for the Endpoint.This can be anyString
.Endpoint
getEndpoint()
Get the Endpoint related to this Endpoint serviceString
getType()
Get the Endpoint Type of the Endpoint Service.String
getUIPageName()
Get the common name of the UI pages for this endpoint serviceboolean
isChildEndpointFormAvailable()
Defines whether this Endpoint Type has a child endpoint form for the list endpoint designer.boolean
isStatisticsAvailable()
Defines whether we can enable the statistics for this Endpoint Type.
-
-
-
Method Detail
-
getEndpoint
public Endpoint getEndpoint()
Description copied from interface:EndpointService
Get the Endpoint related to this Endpoint service- Specified by:
getEndpoint
in interfaceEndpointService
- Returns:
- Endpoint
-
getType
public String getType()
Description copied from interface:EndpointService
Get the Endpoint Type of the Endpoint Service. Ex: Address, WSDL- Specified by:
getType
in interfaceEndpointService
- Returns:
- Endpoint Type
-
getUIPageName
public String getUIPageName()
Description copied from interface:EndpointService
Get the common name of the UI pages for this endpoint service- Specified by:
getUIPageName
in interfaceEndpointService
- Returns:
- UI page name
-
getDescription
public String getDescription()
Description copied from interface:EndpointService
Get the description of the Endpoint Type. The description should include the the functionality of the the Endpoint type- Specified by:
getDescription
in interfaceEndpointService
- Returns:
- description of the Endpoint type
-
getDisplayName
public String getDisplayName()
Description copied from interface:EndpointService
This gives the display name for the Endpoint.This can be anyString
. It is recommended to put a meaning full descriptive short name as the display name- Specified by:
getDisplayName
in interfaceEndpointService
- Returns:
- display name of the Endpoint Type
-
isStatisticsAvailable
public boolean isStatisticsAvailable()
Description copied from interface:EndpointService
Defines whether we can enable the statistics for this Endpoint Type. Enable/Disable Statistics option will be available only if this is set to true- Specified by:
isStatisticsAvailable
in interfaceEndpointService
- Returns:
- whether we can enable the statistics for this Endpoint Type
-
canAddAsChild
public boolean canAddAsChild()
Description copied from interface:EndpointService
Defines whether this Endpoint Type can be add as a child Endpoint of a List Endpoint like LoadBalance Endpoint. If this is set to false you will not see a menu item for this Endpoint type in the AddMenu of the listEndpoint designer.- Specified by:
canAddAsChild
in interfaceEndpointService
- Returns:
- whether this Endpoint Type can be add as a child Endpoint of a List Endpoint
-
canAddAsTemplate
public boolean canAddAsTemplate()
Description copied from interface:EndpointService
Defines whether we can create a template from this Endpoint Type. If this is set to false you will not see a entry for this endpoint type in the Endpoint Template designer- Specified by:
canAddAsTemplate
in interfaceEndpointService
- Returns:
- whether we can create a template from this Endpoint Type
-
isChildEndpointFormAvailable
public boolean isChildEndpointFormAvailable()
Description copied from interface:EndpointService
Defines whether this Endpoint Type has a child endpoint form for the list endpoint designer. This is used by thelistEndpointDesigner
- Specified by:
isChildEndpointFormAvailable
in interfaceEndpointService
- Returns:
- whether child endpoint form exists for this endpoint type
-
-