javax.jbi.servicedesc
Interface ServiceEndpoint

public interface ServiceEndpoint

Reference to an endpoint, used to refer an endpoint as well as query information about the endpoint.

An endpoint is an addressable entity in the JBI system, used for accessing the provider of a specific service.

This interface is implemented by both the JBI implementation and JBI components, in the following use cases:

• Activated endpoints: created by JBI implementation.
• Internal endpoints from endpoint resolution: created by the component implementation.
• Registered external endpoints: created by the component implementation.

See the JBI Specification for details on requirements imposed on components in the latter two use cases.

Author:

JSR208 Expert Group

Method Summary

org.w3c.dom.DocumentFragment	getAsReference(javax.xml.namespace.QName operationName) Get a reference to this endpoint, using an endpoint reference vocabulary that is known to the provider.
java.lang.String	getEndpointName() Returns the endpoint name of this reference.
javax.xml.namespace.QName[]	getInterfaces() Get the qualified names of all the interfaces implemented by this service endpoint.
javax.xml.namespace.QName	getServiceName() Returns the service name of this reference.

Method Detail

getAsReference

org.w3c.dom.DocumentFragment getAsReference(javax.xml.namespace.QName operationName)

Get a reference to this endpoint, using an endpoint reference vocabulary that is known to the provider.

Parameters:

operationName - the name of the operation to be performed by a consumer of the generated EPR; nullReturns:

endpoint reference as an XML fragment; null if the provider does not support such references

getEndpointName

java.lang.String getEndpointName()

Returns the endpoint name of this reference.

Returns:

endpoint name; must be non-null and non-empty

getInterfaces

javax.xml.namespace.QName[] getInterfaces()

Get the qualified names of all the interfaces implemented by this service endpoint.

Returns:

array of all interfaces implemented by this service endpoint; must be non-null and non-empty

getServiceName

javax.xml.namespace.QName getServiceName()

Returns the service name of this reference.

Returns:

qualified service name; must be non-null