Interface EndpointService
-
- All Known Implementing Classes:
AddressEndpointService
,DefaultEndpointService
,FailoverEndpointService
,HttpEndpointService
,LoadBalanceEndpointService
,RecipientlistEndpointService
,TemplateEndpointService
,WsdlEndpointService
public interface EndpointService
This provides the basic structure of a endpoint service for the endpoint editor ui,
-
-
Method Summary
All Methods Instance Methods Abstract 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
Endpoint getEndpoint()
Get the Endpoint related to this Endpoint service- Returns:
- Endpoint
-
getType
String getType()
Get the Endpoint Type of the Endpoint Service. Ex: Address, WSDL- Returns:
- Endpoint Type
-
getUIPageName
String getUIPageName()
Get the common name of the UI pages for this endpoint service- Returns:
- UI page name
-
getDescription
String getDescription()
Get the description of the Endpoint Type. The description should include the the functionality of the the Endpoint type- Returns:
- description of the Endpoint type
-
getDisplayName
String getDisplayName()
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- Returns:
- display name of the Endpoint Type
-
isStatisticsAvailable
boolean isStatisticsAvailable()
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- Returns:
- whether we can enable the statistics for this Endpoint Type
-
canAddAsChild
boolean canAddAsChild()
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.- Returns:
- whether this Endpoint Type can be add as a child Endpoint of a List Endpoint
-
canAddAsTemplate
boolean canAddAsTemplate()
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- Returns:
- whether we can create a template from this Endpoint Type
-
isChildEndpointFormAvailable
boolean isChildEndpointFormAvailable()
Defines whether this Endpoint Type has a child endpoint form for the list endpoint designer. This is used by thelistEndpointDesigner
- Returns:
- whether child endpoint form exists for this endpoint type
-
-