org.ow2.util.ee.metadata.common.api.struct
Interface IJaxwsWebServiceRef

All Superinterfaces:

Serializable

public interface IJaxwsWebServiceRef
extends Serializable

Manage WebServiceRef metadata.

Author:

Guillaume Sauthier

Method Summary

String	getDeclaringClass()
String	getHandlerChainFile()
IHandlerChains	getHandlerChains()
String	getMappedName()
String	getName()
IPortComponentRef	getPortComponentRef(String serviceEndpointInterface) Gets a port component ref by providings its service endpoint interface.
List<IPortComponentRef>	getPortComponentRefs()
String	getType()
String	getValue() The service class, always a type extending javax.xml.ws.Service.
String	getWsdlLocation()
void	setDeclaringClass(String declaringClassname)
void	setHandlerChainFile(String fileAttribute) Store the value of the @HandlerChain.file attribute which is collocated with this @WebServiceRef.
void	setHandlerChains(IHandlerChains handlerChains) Stores an Object representation of a handler-chains defined in standard descriptors.
void	setMappedName(String mappedName) A product specific name that this resource should be mapped to.
void	setName(String name) The JNDI name of the resource.
void	setPortComponentRefs(List<IPortComponentRef> portComponentRefs) Stores all port component refs.
void	setType(String type) The Java type of the resource.
void	setValue(String value) This element must be specified whenever the type of the reference is a service endpoint interface.
void	setWsdlLocation(String wsdlLocation) A URL pointing to the WSDL document for the web service.

Method Detail

getMappedName

String getMappedName()

Returns:

A product specific name that this resource should be mapped to.

setMappedName

void setMappedName(String mappedName)

A product specific name that this resource should be mapped to.

Parameters:

mappedName - product specific name

getName

String getName()

Returns:

The JNDI name of the resource.

setName

void setName(String name)

The JNDI name of the resource.

Parameters:

name - JNDI name

getType

String getType()

Returns:

The Java type of the resource.

setType

void setType(String type)

The Java type of the resource.

Parameters:

type - Java type

getValue

String getValue()

The service class, always a type extending javax.xml.ws.Service. This element must be specified whenever the type of the reference is a service endpoint interface.

Returns:

The service class, always a type extending javax.xml.ws.Service

setValue

void setValue(String value)

This element must be specified whenever the type of the reference is a service endpoint interface.

Parameters:

value - The service class, always a type extending javax.xml.ws.Service

getWsdlLocation

String getWsdlLocation()

Returns:

A URL pointing to the WSDL document for the web service.

setWsdlLocation

void setWsdlLocation(String wsdlLocation)

A URL pointing to the WSDL document for the web service. If not specified, the WSDL location specified by annotations on the resource type is used instead.

Parameters:

wsdlLocation - Absolute URL or relative URL (to the module)

setHandlerChainFile

void setHandlerChainFile(String fileAttribute)

Store the value of the @HandlerChain.file attribute which is collocated with this @WebServiceRef.

Parameters:

fileAttribute - attribute's value

getHandlerChainFile

String getHandlerChainFile()

Returns:

the value of the @HandlerChain.file attribute.

setHandlerChains

void setHandlerChains(IHandlerChains handlerChains)

Stores an Object representation of a handler-chains defined in standard descriptors.

Parameters:

handlerChains - handler-chains as Object.

getHandlerChains

IHandlerChains getHandlerChains()

Returns:

the value of the handler-chains Object representation.

setPortComponentRefs

void setPortComponentRefs(List<IPortComponentRef> portComponentRefs)

Stores all port component refs.

Parameters:

portComponentRefs - list of port component ref.

getPortComponentRefs

List<IPortComponentRef> getPortComponentRefs()

Returns:

the value of the list of port component refs.

getPortComponentRef

IPortComponentRef getPortComponentRef(String serviceEndpointInterface)

Gets a port component ref by providings its service endpoint interface.

Parameters:

serviceEndpointInterface - the given SEI

Returns:

a port component ref or null if not found

setDeclaringClass

void setDeclaringClass(String declaringClassname)

Parameters:

declaringClassname - Class declaring the @HandlerChain annotation.

getDeclaringClass

String getDeclaringClass()

Returns:

Name of the class declaring the @HandlerChain annotation (will be null if no @HC annotation is present).