org.glassfish.webservices

Class WsUtil

java.lang.Object

org.glassfish.webservices.WsUtil

public class WsUtil
extends Object

Web service related utilities.

Author:

Kenneth Saks

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_TRANSPORT_LOG_PROPERTY
static String	ENDPOINT_ADDRESS_PARAM_NAME
static String	SCHEMA_IMPORT_LOCATION_PARAM_NAME
String	SCHEMA_IMPORT_NAMESPACE_PARAM_NAME
static String	SCHEMA_INCLUDE_LOCATION_PARAM_NAME
static String	WSDL_IMPORT_LOCATION_PARAM_NAME
String	WSDL_IMPORT_NAMESPACE_PARAM_NAME
static String	WSDL_INCLUDE_LOCATION_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
WsUtil()

Method Summary

Modifier and Type	Method and Description
void	configureHandlerChain(ServiceReferenceDescriptor serviceRef, javax.xml.rpc.Service service, Iterator ports, ClassLoader loader)
void	configureJAXWSClientHandlers(Service svcClass, ServiceReferenceDescriptor desc)
void	configureJAXWSServiceHandlers(WebServiceEndpoint ep, String bindingId, com.sun.xml.ws.api.WSBinding bindingObj)
javax.xml.rpc.Service	createConfiguredService(ServiceReferenceDescriptor desc)
javax.xml.rpc.handler.HandlerInfo	createHandlerInfo(WebServiceHandler handler, ClassLoader loader)
void	doPostConstruct(Class impl, Object implObj)
void	doPreDestroy(WebServiceEndpoint ep, ClassLoader loader)
void	generateFinalWsdl(URL wsdlFileUrl, WebService webService, WebServerInfo wsi, File finalWsdlFile) Transform the deployed WSDL document for a given webservice by replacing the ENDPOINT ADDRESS for each port with the actual endpoint address on which it will be listening.
void	generateFinalWsdl(URL wsdlFileUrl, WebService webService, WebServerInfo wsi, OutputStream outputStream)
Collection	getAllPorts(com.sun.xml.rpc.spi.model.Model model)
static Logger	getDefaultLogger()
static LocalStringManagerImpl	getDefaultStringManager()
Method	getInvMethod(com.sun.xml.rpc.spi.runtime.Tie webServiceTie, javax.xml.rpc.handler.MessageContext context)
boolean	getMtom(WebServiceEndpoint ep)
com.sun.xml.rpc.spi.model.Port	getPortFromModel(com.sun.xml.rpc.spi.model.Model model, QName portName) Find a Port object within the JAXRPC Model.
Collection	getSEIsFromGeneratedService(Class generatedServiceInterface)
com.sun.xml.rpc.spi.model.Service	getServiceForPort(com.sun.xml.rpc.spi.model.Model model, QName thePortName) Find a Service in which a particular port is defined.
static SOAPMessage	getSOAPFault(String protocol, String faultString)
WebServerInfo	getWebServerInfoForDAS()
String	getWsdlDir(BundleDescriptor bundle)
Collection	getWsdlsAndSchemas(File pkgedWsdl)
void	getWsdlsAndSchemas(File wsdl, ArrayList<com.sun.xml.ws.api.server.SDDocumentSource> cumulative)
Collection	getWsdlsAndSchemas(URL pkgedWsdl) This implementation is similar to #getWsdlsAndSchemas(File pkgedWsdl, except that this works on URL which makes it easy when the wsdl is loaded from the archive.
boolean	handleGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, WebServiceEndpoint endpoint) Serve up the FINAL wsdl associated with this web service.
boolean	isJAXWSbasedService(WebService ws)
boolean	isWsdlContent(String uri, BundleDescriptor bundle) All wsdl files and wsdl imported files live under a well-known wsdl directory.
boolean	portsEqual(com.sun.xml.rpc.spi.model.Port port, QName candidatePortName) Logic for matching a port qname with a Port object from the JAXRPC-RI Model.
URL	privilegedGetServiceRefWsdl(ServiceReferenceDescriptor desc) Accessing wsdl URL might involve file system access, so wrap operation in a doPrivileged block.
static void	raiseException(javax.servlet.http.HttpServletResponse resp, String binding, String faultString)
void	throwSOAPFaultException(String faultString, javax.xml.rpc.handler.MessageContext msgContext) Convenience method for throwing a SOAP fault exception.
void	throwSOAPFaultException(String faultString, SOAPMessage soapMessage)
void	updateServletEndpointRuntime(WebServiceEndpoint endpoint)
void	validateEjbEndpoint(WebServiceEndpoint ejbEndpoint)

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_TRANSPORT_LOG_PROPERTY

public static final String CLIENT_TRANSPORT_LOG_PROPERTY

See Also:

Constant Field Values

ENDPOINT_ADDRESS_PARAM_NAME

public static final String ENDPOINT_ADDRESS_PARAM_NAME

See Also:

Constant Field Values

WSDL_IMPORT_NAMESPACE_PARAM_NAME

public final String WSDL_IMPORT_NAMESPACE_PARAM_NAME

See Also:

Constant Field Values

WSDL_IMPORT_LOCATION_PARAM_NAME

public static final String WSDL_IMPORT_LOCATION_PARAM_NAME

See Also:

Constant Field Values

WSDL_INCLUDE_LOCATION_PARAM_NAME

public static final String WSDL_INCLUDE_LOCATION_PARAM_NAME

See Also:

Constant Field Values

SCHEMA_IMPORT_NAMESPACE_PARAM_NAME

public final String SCHEMA_IMPORT_NAMESPACE_PARAM_NAME

See Also:

Constant Field Values

SCHEMA_IMPORT_LOCATION_PARAM_NAME

public static final String SCHEMA_IMPORT_LOCATION_PARAM_NAME

See Also:

Constant Field Values

SCHEMA_INCLUDE_LOCATION_PARAM_NAME

public static final String SCHEMA_INCLUDE_LOCATION_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

WsUtil

public WsUtil()

Method Detail

handleGet

public boolean handleGet(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         WebServiceEndpoint endpoint)
                  throws IOException

Serve up the FINAL wsdl associated with this web service.

Returns:

true for success, false for failure

Throws:

IOException

isWsdlContent

public boolean isWsdlContent(String uri,
                             BundleDescriptor bundle)

All wsdl files and wsdl imported files live under a well-known wsdl directory.

Parameters:

uri - module uri

getWsdlDir

public String getWsdlDir(BundleDescriptor bundle)

Returns:

module-specific dedicated wsdl directory

generateFinalWsdl

public void generateFinalWsdl(URL wsdlFileUrl,
                              WebService webService,
                              WebServerInfo wsi,
                              File finalWsdlFile)
                       throws Exception

Transform the deployed WSDL document for a given webservice by replacing the ENDPOINT ADDRESS for each port with the actual endpoint address on which it will be listening.

Throws:

Exception

generateFinalWsdl

public void generateFinalWsdl(URL wsdlFileUrl,
                              WebService webService,
                              WebServerInfo wsi,
                              OutputStream outputStream)
                       throws Exception

Throws:

Exception

createHandlerInfo

public javax.xml.rpc.handler.HandlerInfo createHandlerInfo(WebServiceHandler handler,
                                                           ClassLoader loader)
                                                    throws Exception

Throws:

Exception

privilegedGetServiceRefWsdl

public URL privilegedGetServiceRefWsdl(ServiceReferenceDescriptor desc)
                                throws Exception

Accessing wsdl URL might involve file system access, so wrap operation in a doPrivileged block.

Throws:

Exception

isJAXWSbasedService

public boolean isJAXWSbasedService(WebService ws)

createConfiguredService

public javax.xml.rpc.Service createConfiguredService(ServiceReferenceDescriptor desc)
                                              throws Exception

Throws:

Exception

configureHandlerChain

public void configureHandlerChain(ServiceReferenceDescriptor serviceRef,
                                  javax.xml.rpc.Service service,
                                  Iterator ports,
                                  ClassLoader loader)
                           throws Exception

Throws:

Exception

getSEIsFromGeneratedService

public Collection getSEIsFromGeneratedService(Class generatedServiceInterface)
                                       throws Exception

Returns:

Set of service endpoint interface class names supported by a generated service interface.

Throws:

Exception

getPortFromModel

public com.sun.xml.rpc.spi.model.Port getPortFromModel(com.sun.xml.rpc.spi.model.Model model,
                                                       QName portName)

Find a Port object within the JAXRPC Model.

getServiceForPort

public com.sun.xml.rpc.spi.model.Service getServiceForPort(com.sun.xml.rpc.spi.model.Model model,
                                                           QName thePortName)

Find a Service in which a particular port is defined. Assumes port QName is unique within a WSDL.

portsEqual

public boolean portsEqual(com.sun.xml.rpc.spi.model.Port port,
                          QName candidatePortName)

Logic for matching a port qname with a Port object from the JAXRPC-RI Model.

getAllPorts

public Collection getAllPorts(com.sun.xml.rpc.spi.model.Model model)

getInvMethod

public Method getInvMethod(com.sun.xml.rpc.spi.runtime.Tie webServiceTie,
                           javax.xml.rpc.handler.MessageContext context)
                    throws Exception

Returns:

a method object representing the target of a web service invocation

Throws:

Exception

throwSOAPFaultException

public void throwSOAPFaultException(String faultString,
                                    javax.xml.rpc.handler.MessageContext msgContext)

Convenience method for throwing a SOAP fault exception.

throwSOAPFaultException

public void throwSOAPFaultException(String faultString,
                                    SOAPMessage soapMessage)
                             throws javax.xml.rpc.soap.SOAPFaultException

Throws:

javax.xml.rpc.soap.SOAPFaultException

raiseException

public static void raiseException(javax.servlet.http.HttpServletResponse resp,
                                  String binding,
                                  String faultString)

getSOAPFault

public static SOAPMessage getSOAPFault(String protocol,
                                       String faultString)

getWebServerInfoForDAS

public WebServerInfo getWebServerInfoForDAS()

getDefaultLogger

public static Logger getDefaultLogger()

Returns:

the default Logger implementation for this package

getDefaultStringManager

public static LocalStringManagerImpl getDefaultStringManager()

validateEjbEndpoint

public void validateEjbEndpoint(WebServiceEndpoint ejbEndpoint)

updateServletEndpointRuntime

public void updateServletEndpointRuntime(WebServiceEndpoint endpoint)

getWsdlsAndSchemas

public Collection getWsdlsAndSchemas(File pkgedWsdl)
                              throws Exception

Throws:

Exception

getWsdlsAndSchemas

public Collection getWsdlsAndSchemas(URL pkgedWsdl)
                              throws Exception

This implementation is similar to #getWsdlsAndSchemas(File pkgedWsdl, except that this works on URL which makes it easy when the wsdl is loaded from the archive.

Parameters:

pkgedWsdl - URL

Returns:

Throws:

Exception

getWsdlsAndSchemas

public void getWsdlsAndSchemas(File wsdl,
                               ArrayList<com.sun.xml.ws.api.server.SDDocumentSource> cumulative)
                        throws Exception

Throws:

Exception

doPostConstruct

public void doPostConstruct(Class impl,
                            Object implObj)

doPreDestroy

public void doPreDestroy(WebServiceEndpoint ep,
                         ClassLoader loader)

configureJAXWSServiceHandlers

public void configureJAXWSServiceHandlers(WebServiceEndpoint ep,
                                          String bindingId,
                                          com.sun.xml.ws.api.WSBinding bindingObj)

configureJAXWSClientHandlers

public void configureJAXWSClientHandlers(Service svcClass,
                                         ServiceReferenceDescriptor desc)

getMtom

public boolean getMtom(WebServiceEndpoint ep)