org.mule.devkit.api.ws.definition

Interface ServiceDefinition

All Known Implementing Classes:

DefaultServiceDefinition

public interface ServiceDefinition

A representation of a WSDL file that can be accessible either locally (e.g.: within the connector's jar) or remote (e.g.: URLs), that will be used for runtime (Mule ESB) or design time (Anypoint Studio) purposes.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName()
List<String>	getExcludedOperations()
String	getId()
com.google.common.base.Optional<String>	getPort()
Map<String,Object>	getProperties()
com.google.common.base.Optional<String>	getService()
URL	getWsdlUrl()

Method Detail

getId

String getId()

Returns:

the ID that will represent a given WSDL file. E.g.: INCIDENT_MODULE_ID.

getDisplayName

String getDisplayName()

Returns:

the fancy name the end user will see in Studio's UI. E.g.: Incident Module.

getWsdlUrl

URL getWsdlUrl()

Returns:

URLs that targets the real WSDL file.

getService

com.google.common.base.Optional<String> getService()

Returns:

service's name of the given WSDL file. It might be left to null (which implies Optional.absent()), or it could have a concrete value. If it's left to null, then DevKit will do its best effort to pick it automatically.

getPort

com.google.common.base.Optional<String> getPort()

Returns:

port's name for a given service of the given WSDL file. It might be left to null (which implies Optional.absent()), or it could have a concrete value. If it's left to null, then DevKit will do its best effort to pick it automatically.

getProperties

Map<String,Object> getProperties()

Returns:

a set of properties for the current representation of a WSDL file. This is a placeholder to store metadata that might be useful when resolving a service address for the given WSDL file.

getExcludedOperations

List<String> getExcludedOperations()

Returns:

a List of operation names that should be excluded from the exposed service definition.