WebServiceServer (citrus-ws 2.4 API)

java.lang.Object
- com.consol.citrus.endpoint.AbstractEndpoint
- - com.consol.citrus.server.AbstractServer
  - - com.consol.citrus.ws.server.WebServiceServer

All Implemented Interfaces:

Endpoint, Server, Runnable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
```
public class WebServiceServer
extends AbstractServer
implements org.springframework.context.ApplicationContextAware
```
Jetty server implementation wrapping a Server with Citrus server behaviour, so server can be started/stopped by Citrus.

Author:

Christoph Deppisch

Field Summary
- Fields inherited from class com.consol.citrus.server.AbstractServer
  DEFAULT_CHANNEL_ID_SUFFIX

Constructor Summary

Constructors
Constructor and Description

WebServiceServer()

Constructors
Constructor and Description
`WebServiceServer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.eclipse.jetty.server.Connector`	`getConnector()` Gets the connector.
`org.eclipse.jetty.server.Connector[]`	`getConnectors()` Gets the connectors.
`String`	`getContextConfigLocation()` Gets the contextConfigLocation.
`String`	`getContextPath()` Gets the contextPath.
`WebServiceMessageConverter`	`getMessageConverter()` Gets the message converter.
`String`	`getMessageFactoryName()` Gets the message factory name.
`int`	`getPort()` Gets the port.
`String`	`getResourceBase()` Gets the resourceBase.
`org.eclipse.jetty.security.SecurityHandler`	`getSecurityHandler()` Gets the securityHandler.
`org.eclipse.jetty.servlet.ServletHandler`	`getServletHandler()` Gets the servletHandler.
`String`	`getServletMappingPath()` Gets the servletMappingPath.
`String`	`getServletName()` Gets the customized servlet name or default name if not set.
`String`	`getSoapHeaderNamespace()` Gets the default soap header namespace.
`String`	`getSoapHeaderPrefix()` Gets the default soap header prefix.
`boolean`	`isHandleMimeHeaders()` Should handle mime headers.
`boolean`	`isKeepSoapEnvelope()` Gets the keep soap envelope flag.
`boolean`	`isUseRootContextAsParent()` Gets the useRootContextAsParent.
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`void`	`setConnector(org.eclipse.jetty.server.Connector connector)` Sets the connector.
`void`	`setConnectors(org.eclipse.jetty.server.Connector[] connectors)` Sets the connectors.
`void`	`setContextConfigLocation(String contextConfigLocation)` Sets the contextConfigLocation.
`void`	`setContextPath(String contextPath)` Sets the contextPath.
`void`	`setHandleMimeHeaders(boolean handleMimeHeaders)` Enable mime headers in request message which is passed to endpoint adapter.
`void`	`setKeepSoapEnvelope(boolean keepSoapEnvelope)` Sets the keep soap header flag.
`void`	`setMessageConverter(WebServiceMessageConverter messageConverter)` Sets the message converter.
`void`	`setMessageFactoryName(String messageFactoryName)` Sets the message factory name.
`void`	`setPort(int port)` Sets the port.
`void`	`setResourceBase(String resourceBase)` Sets the resourceBase.
`void`	`setSecurityHandler(org.eclipse.jetty.security.SecurityHandler securityHandler)` Sets the securityHandler.
`void`	`setServletHandler(org.eclipse.jetty.servlet.ServletHandler servletHandler)` Sets the servletHandler.
`void`	`setServletMappingPath(String servletMappingPath)` Sets the servletMappingPath.
`void`	`setServletName(String servletName)` Sets the servletName.
`void`	`setSoapHeaderNamespace(String soapHeaderNamespace)` Sets the default soap header namespace.
`void`	`setSoapHeaderPrefix(String soapHeaderPrefix)` Sets the default soap header prefix.
`void`	`setUseRootContextAsParent(boolean useRootContextAsParent)` Sets the useRootContextAsParent.
`protected void`	`shutdown()`
`protected void`	`startup()`

Methods inherited from class com.consol.citrus.server.AbstractServer
afterPropertiesSet, createConsumer, createProducer, destroy, getBeanFactory, getDefaultTimeout, getEndpointAdapter, getEndpointConfiguration, getInterceptors, isAutoStart, isRunning, join, run, setAutoStart, setBeanFactory, setDefaultTimeout, setEndpointAdapter, setInterceptors, setRunning, start, stop

Methods inherited from class com.consol.citrus.endpoint.AbstractEndpoint
getActor, getConsumerName, getName, getProducerName, setActor, setBeanName, setName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.consol.citrus.endpoint.Endpoint
getActor, getName, setActor, setName

- Constructor Detail
  - WebServiceServer
```
public WebServiceServer()
```
- Method Detail
  - shutdown
```
protected void shutdown()
```
    Specified by:
    
    shutdown in class AbstractServer
  - startup
```
protected void startup()
```
    Specified by:
    
    startup in class AbstractServer
  - getServletName
```
public String getServletName()
```
    Gets the customized servlet name or default name if not set.
    
    Returns:
    
    the servletName
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - getPort
```
public int getPort()
```
    Gets the port.
    
    Returns:
    
    the port the port to get.
  - setPort
```
public void setPort(int port)
```
    Sets the port.
    
    Parameters:
    
    port - the port to set
  - getResourceBase
```
public String getResourceBase()
```
    Gets the resourceBase.
    
    Returns:
    
    the resourceBase the resourceBase to get.
  - setResourceBase
```
public void setResourceBase(String resourceBase)
```
    Sets the resourceBase.
    
    Parameters:
    
    resourceBase - the resourceBase to set
  - getContextConfigLocation
```
public String getContextConfigLocation()
```
    Gets the contextConfigLocation.
    
    Returns:
    
    the contextConfigLocation the contextConfigLocation to get.
  - setContextConfigLocation
```
public void setContextConfigLocation(String contextConfigLocation)
```
    Sets the contextConfigLocation.
    
    Parameters:
    
    contextConfigLocation - the contextConfigLocation to set
  - getConnector
```
public org.eclipse.jetty.server.Connector getConnector()
```
    Gets the connector.
    
    Returns:
    
    the connector the connector to get.
  - setConnector
```
public void setConnector(org.eclipse.jetty.server.Connector connector)
```
    Sets the connector.
    
    Parameters:
    
    connector - the connector to set
  - getConnectors
```
public org.eclipse.jetty.server.Connector[] getConnectors()
```
    Gets the connectors.
    
    Returns:
    
    the connectors
  - setConnectors
```
public void setConnectors(org.eclipse.jetty.server.Connector[] connectors)
```
    Sets the connectors.
    
    Parameters:
    
    connectors - the connectors to set
  - getServletMappingPath
```
public String getServletMappingPath()
```
    Gets the servletMappingPath.
    
    Returns:
    
    the servletMappingPath the servletMappingPath to get.
  - setServletMappingPath
```
public void setServletMappingPath(String servletMappingPath)
```
    Sets the servletMappingPath.
    
    Parameters:
    
    servletMappingPath - the servletMappingPath to set
  - getContextPath
```
public String getContextPath()
```
    Gets the contextPath.
    
    Returns:
    
    the contextPath the contextPath to get.
  - setContextPath
```
public void setContextPath(String contextPath)
```
    Sets the contextPath.
    
    Parameters:
    
    contextPath - the contextPath to set
  - getSecurityHandler
```
public org.eclipse.jetty.security.SecurityHandler getSecurityHandler()
```
    Gets the securityHandler.
    
    Returns:
    
    the securityHandler the securityHandler to get.
  - setSecurityHandler
```
public void setSecurityHandler(org.eclipse.jetty.security.SecurityHandler securityHandler)
```
    Sets the securityHandler.
    
    Parameters:
    
    securityHandler - the securityHandler to set
  - getServletHandler
```
public org.eclipse.jetty.servlet.ServletHandler getServletHandler()
```
    Gets the servletHandler.
    
    Returns:
    
    the servletHandler the servletHandler to get.
  - setServletHandler
```
public void setServletHandler(org.eclipse.jetty.servlet.ServletHandler servletHandler)
```
    Sets the servletHandler.
    
    Parameters:
    
    servletHandler - the servletHandler to set
  - setServletName
```
public void setServletName(String servletName)
```
    Sets the servletName.
    
    Parameters:
    
    servletName - the servletName to set
  - isUseRootContextAsParent
```
public boolean isUseRootContextAsParent()
```
    Gets the useRootContextAsParent.
    
    Returns:
    
    the useRootContextAsParent the useRootContextAsParent to get.
  - setUseRootContextAsParent
```
public void setUseRootContextAsParent(boolean useRootContextAsParent)
```
    Sets the useRootContextAsParent.
    
    Parameters:
    
    useRootContextAsParent - the useRootContextAsParent to set
  - isHandleMimeHeaders
```
public boolean isHandleMimeHeaders()
```
    Should handle mime headers.
    
    Returns:
  - setHandleMimeHeaders
```
public void setHandleMimeHeaders(boolean handleMimeHeaders)
```
    Enable mime headers in request message which is passed to endpoint adapter.
    
    Parameters:
    
    handleMimeHeaders - the handleMimeHeaders to set
  - isKeepSoapEnvelope
```
public boolean isKeepSoapEnvelope()
```
    Gets the keep soap envelope flag.
    
    Returns:
  - setKeepSoapEnvelope
```
public void setKeepSoapEnvelope(boolean keepSoapEnvelope)
```
    Sets the keep soap header flag.
    
    Parameters:
    
    keepSoapEnvelope -
  - getSoapHeaderNamespace
```
public String getSoapHeaderNamespace()
```
    Gets the default soap header namespace.
    
    Returns:
  - setSoapHeaderNamespace
```
public void setSoapHeaderNamespace(String soapHeaderNamespace)
```
    Sets the default soap header namespace.
    
    Parameters:
    
    soapHeaderNamespace -
  - getSoapHeaderPrefix
```
public String getSoapHeaderPrefix()
```
    Gets the default soap header prefix.
    
    Returns:
  - setSoapHeaderPrefix
```
public void setSoapHeaderPrefix(String soapHeaderPrefix)
```
    Sets the default soap header prefix.
    
    Parameters:
    
    soapHeaderPrefix -
  - getMessageConverter
```
public WebServiceMessageConverter getMessageConverter()
```
    Gets the message converter.
    
    Returns:
  - setMessageConverter
```
public void setMessageConverter(WebServiceMessageConverter messageConverter)
```
    Sets the message converter.
    
    Parameters:
    
    messageConverter -
  - getMessageFactoryName
```
public String getMessageFactoryName()
```
    Gets the message factory name.
    
    Returns:
  - setMessageFactoryName
```
public void setMessageFactoryName(String messageFactoryName)
```
    Sets the message factory name.
    
    Parameters:
    
    messageFactoryName -

Class WebServiceServer

Field Summary

Fields inherited from class com.consol.citrus.server.AbstractServer

Constructor Summary

Method Summary

Methods inherited from class com.consol.citrus.server.AbstractServer

Methods inherited from class com.consol.citrus.endpoint.AbstractEndpoint

Methods inherited from class java.lang.Object

Methods inherited from interface com.consol.citrus.endpoint.Endpoint

Constructor Detail

WebServiceServer

Method Detail

shutdown

startup

getServletName

setApplicationContext

getPort

setPort

getResourceBase

setResourceBase

getContextConfigLocation

setContextConfigLocation

getConnector

setConnector

getConnectors

setConnectors

getServletMappingPath

setServletMappingPath

getContextPath

setContextPath

getSecurityHandler

setSecurityHandler

getServletHandler

setServletHandler

setServletName

isUseRootContextAsParent

setUseRootContextAsParent

isHandleMimeHeaders

setHandleMimeHeaders

isKeepSoapEnvelope

setKeepSoapEnvelope

getSoapHeaderNamespace

setSoapHeaderNamespace

getSoapHeaderPrefix

setSoapHeaderPrefix

getMessageConverter

setMessageConverter

getMessageFactoryName

setMessageFactoryName