Package org.wso2.carbon.endpoint.ui.endpoints.template

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

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 any String.
Endpoint	getEndpoint()	Get the Endpoint related to this Endpoint service
String	getType()	Get the Endpoint Type of the Endpoint Service.
String	getUIPageName()	Get the common name of the UI pages for this endpoint service
boolean	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateEndpointService

public TemplateEndpointService()

Method Detail

getEndpoint

public Endpoint getEndpoint()

Description copied from interface: EndpointService

Get the Endpoint related to this Endpoint service

Specified by:

getEndpoint in interface EndpointService

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 interface EndpointService

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 interface EndpointService

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 interface EndpointService

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 any String. It is recommended to put a meaning full descriptive short name as the display name

Specified by:

getDisplayName in interface EndpointService

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 interface EndpointService

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 interface EndpointService

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 interface EndpointService

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 the listEndpointDesigner

Specified by:

isChildEndpointFormAvailable in interface EndpointService

Returns:

whether child endpoint form exists for this endpoint type