org.apache.axis.deployment.wsdd

Class WSDDService

Implemented Interfaces:
Serializable, WSDDTypeMappingContainer

public class WSDDService
extends WSDDTargetedChain
implements WSDDTypeMappingContainer

A service represented in WSDD.
Author:
Glen Daniels (gdaniels@apache.org)

Field Summary

Fields inherited from class org.apache.axis.deployment.wsdd.WSDDDeployableItem

SCOPE_PER_ACCESS, SCOPE_PER_REQUEST, SCOPE_SINGLETON, log, parameters, qname, scope, scopeStrings, singletonInstance, type

Fields inherited from class org.apache.axis.deployment.wsdd.WSDDConstants

ARRAY_DESERIALIZER_FACTORY, ARRAY_SERIALIZER_FACTORY, ATTR_ATTACHMENT_FORMAT, ATTR_CLASS, ATTR_CLASSNAME, ATTR_DESERIALIZER, ATTR_ENCSTYLE, ATTR_INHEADER, ATTR_INNER_NAME, ATTR_INNER_TYPE, ATTR_ITEMQNAME, ATTR_ITEMTYPE, ATTR_LANG_SPEC_TYPE, ATTR_LOCKED, ATTR_MEP, ATTR_MODE, ATTR_NAME, ATTR_OUTHEADER, ATTR_PIVOT, ATTR_PROVIDER, ATTR_QNAME, ATTR_RETHEADER, ATTR_RETITEMQNAME, ATTR_RETITEMTYPE, ATTR_RETQNAME, ATTR_RETTYPE, ATTR_SERIALIZER, ATTR_SOAP12ACTION, ATTR_SOAPACTION, ATTR_SOAPACTORNAME, ATTR_STREAMING, ATTR_STYLE, ATTR_TYPE, ATTR_USE, ATTR_VALUE, BEAN_DESERIALIZER_FACTORY, BEAN_SERIALIZER_FACTORY, ELEM_WSDD_ARRAYMAPPING, ELEM_WSDD_BEANMAPPING, ELEM_WSDD_CHAIN, ELEM_WSDD_DEPLOY, ELEM_WSDD_DOC, ELEM_WSDD_ELEMENTMAPPING, ELEM_WSDD_ENDPOINTURL, ELEM_WSDD_FAULT, ELEM_WSDD_FAULTFLOW, ELEM_WSDD_GLOBAL, ELEM_WSDD_HANDLER, ELEM_WSDD_JAXRPC_CHAIN, ELEM_WSDD_JAXRPC_HANDLERINFO, ELEM_WSDD_JAXRPC_HEADER, ELEM_WSDD_JAXRPC_ROLE, ELEM_WSDD_NAMESPACE, ELEM_WSDD_OPERATION, ELEM_WSDD_PARAM, ELEM_WSDD_REQFLOW, ELEM_WSDD_RESPFLOW, ELEM_WSDD_ROLE, ELEM_WSDD_SERVICE, ELEM_WSDD_TRANSPORT, ELEM_WSDD_TYPEMAPPING, ELEM_WSDD_UNDEPLOY, ELEM_WSDD_WSDLFILE, NS_PREFIX_WSDD, NS_PREFIX_WSDD_JAVA, PROVIDER_BSF, PROVIDER_COM, PROVIDER_CORBA, PROVIDER_EJB, PROVIDER_HANDLER, PROVIDER_MSG, PROVIDER_RMI, PROVIDER_RPC, QNAME_ARRAYMAPPING, QNAME_BEANMAPPING, QNAME_BSF_PROVIDER, QNAME_CHAIN, QNAME_COM_PROVIDER, QNAME_CORBA_PROVIDER, QNAME_DEPLOY, QNAME_DOC, QNAME_EJB_PROVIDER, QNAME_ELEMENTMAPPING, QNAME_ENDPOINTURL, QNAME_FAULT, QNAME_FAULTFLOW, QNAME_GLOBAL, QNAME_HANDLER, QNAME_HANDLER_PROVIDER, QNAME_JAVAMSG_PROVIDER, QNAME_JAVARPC_PROVIDER, QNAME_JAXRPC_HANDLERINFO, QNAME_JAXRPC_HANDLERINFOCHAIN, QNAME_JAXRPC_HEADER, QNAME_JAXRPC_ROLE, QNAME_NAMESPACE, QNAME_OPERATION, QNAME_PARAM, QNAME_REQFLOW, QNAME_RESPFLOW, QNAME_RMI_PROVIDER, QNAME_SERVICE, QNAME_TRANSPORT, QNAME_TYPEMAPPING, QNAME_UNDEPLOY, QNAME_WSDLFILE, URI_WSDD, URI_WSDD_HANDLER, URI_WSDD_JAVA, URI_WSDD_WSDD_BSF, URI_WSDD_WSDD_COM

Constructor Summary

WSDDService()
Default constructor
WSDDService(Element e)

Method Summary

void
addOperation(WSDDOperation operation)
Add a WSDDOperation to the Service.
void
addTypeMapping(WSDDTypeMapping mapping)
Add a WSDDTypeMapping to the Service.
void
deployToRegistry(WSDDDeployment registry)
void
deployTypeMapping(WSDDTypeMapping mapping)
protected QName
getElementName()
WSDDFaultFlow
getFaultFlow(QName name)
WSDDFaultFlow[]
getFaultFlows()
WSDDJAXRPCHandlerInfoChain
getHandlerInfoChain()
Vector
getNamespaces()
Obtain the list of namespaces registered for this service
QName
getProviderQName()
ServiceDesc
getServiceDesc()
String
getServiceDescriptionURL()
Get any service description URL which might be associated with this service.
Style
getStyle()
Get the service style - document or RPC
TypeMapping
getTypeMapping(String encodingStyle)
Vector
getTypeMappings()
Use
getUse()
Get the service use - literal or encoded
protected void
initTMR()
Initialize a TypeMappingRegistry with the WSDDTypeMappings.
Handler
makeNewInstance(EngineConfiguration registry)
void
removeNamespaceMappings(WSDDDeployment registry)
void
setCachedService(SOAPService service)
void
setHandlerInfoChain(WSDDJAXRPCHandlerInfoChain hichain)
void
setProviderQName(QName providerQName)
void
setServiceDescriptionURL(String sdUrl)
Set the service description URL for this service.
void
setStyle(Style style)
Set the service style - document or RPC
void
setTypeMappings(Vector typeMappings)
void
setUse(Use use)
Set the service use - literal or encoded
void
validateDescriptors()
This method can be used for dynamic deployment using new WSDDService() etc.
void
writeToContext(SerializationContext context)
Write this element out to a SerializationContext

Methods inherited from class org.apache.axis.deployment.wsdd.WSDDTargetedChain

deployToRegistry, getFaultFlow, getFaultFlows, getPivotQName, getRequestFlow, getResponseFlow, makeNewInstance, setPivotQName, setRequestFlow, setResponseFlow, setType, writeFlowsToContext

Methods inherited from class org.apache.axis.deployment.wsdd.WSDDDeployableItem

getInstance, getJavaClass, getParameter, getParametersTable, getQName, getType, makeNewInstance, removeParameter, setName, setOptionsHashtable, setParameter, setQName, setType, writeParamsToContext

Methods inherited from class org.apache.axis.deployment.wsdd.WSDDElement

getChildElement, getChildElements, getElementName, writeToContext

Constructor Details

WSDDService

public WSDDService()
Default constructor

WSDDService

public WSDDService(Element e)
            throws WSDDException
Parameters:
e - (Element) XXX
Throws:
WSDDException - XXX

Method Details

addOperation

public void addOperation(WSDDOperation operation)
Add a WSDDOperation to the Service.
Parameters:
operation - the operation to add

addTypeMapping

public void addTypeMapping(WSDDTypeMapping mapping)
Add a WSDDTypeMapping to the Service.
Parameters:
mapping -

deployToRegistry

public void deployToRegistry(WSDDDeployment registry)
Overrides:
deployToRegistry in interface WSDDTargetedChain

deployTypeMapping

public void deployTypeMapping(WSDDTypeMapping mapping)
            throws WSDDException
Specified by:
deployTypeMapping in interface WSDDTypeMappingContainer

getElementName

protected QName getElementName()
Overrides:
getElementName in interface WSDDElement

getFaultFlow

public WSDDFaultFlow getFaultFlow(QName name)
Overrides:
getFaultFlow in interface WSDDTargetedChain
Parameters:
name - XXX
Returns:
XXX

getFaultFlows

public WSDDFaultFlow[] getFaultFlows()
Overrides:
getFaultFlows in interface WSDDTargetedChain
Returns:
XXX

getHandlerInfoChain

public WSDDJAXRPCHandlerInfoChain getHandlerInfoChain()

getNamespaces

public Vector getNamespaces()
Obtain the list of namespaces registered for this service
Returns:
a Vector of namespaces (Strings) which should dispatch to this service

getProviderQName

public QName getProviderQName()

getServiceDesc

public ServiceDesc getServiceDesc()

getServiceDescriptionURL

public String getServiceDescriptionURL()
Get any service description URL which might be associated with this service.
Returns:
a String containing a URL, or null.

getStyle

public Style getStyle()
Get the service style - document or RPC

getTypeMapping

public TypeMapping getTypeMapping(String encodingStyle)

getTypeMappings

public Vector getTypeMappings()

getUse

public Use getUse()
Get the service use - literal or encoded

initTMR

protected void initTMR()
            throws WSDDException
Initialize a TypeMappingRegistry with the WSDDTypeMappings. Note: Extensions of WSDDService may override initTMR to popluate the tmr with different type mappings.

makeNewInstance

public Handler makeNewInstance(EngineConfiguration registry)
            throws ConfigurationException
Overrides:
makeNewInstance in interface WSDDTargetedChain
Parameters:
registry - XXX
Returns:
XXX

removeNamespaceMappings

public void removeNamespaceMappings(WSDDDeployment registry)

setCachedService

public void setCachedService(SOAPService service)

setHandlerInfoChain

public void setHandlerInfoChain(WSDDJAXRPCHandlerInfoChain hichain)

setProviderQName

public void setProviderQName(QName providerQName)

setServiceDescriptionURL

public void setServiceDescriptionURL(String sdUrl)
Set the service description URL for this service.
Parameters:
sdUrl - a String containing a URL

setStyle

public void setStyle(Style style)
Set the service style - document or RPC

setTypeMappings

public void setTypeMappings(Vector typeMappings)

setUse

public void setUse(Use use)
Set the service use - literal or encoded

validateDescriptors

public void validateDescriptors()
            throws WSDDException
This method can be used for dynamic deployment using new WSDDService() etc. It validates some standard parameters for some standard providers (if present). Do this before deployment.deployService().

writeToContext

public void writeToContext(SerializationContext context)
            throws IOException
Write this element out to a SerializationContext
Overrides:
writeToContext in interface WSDDElement

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.