AbstractServer (citrus-core 2.4 API)

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

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
```
public abstract class AbstractServer
extends AbstractEndpoint
implements Server, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.BeanFactoryAware
```
Abstract base class for Server implementations.

Author:

Christoph Deppisch

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_CHANNEL_ID_SUFFIX
Default channel suffix

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CHANNEL_ID_SUFFIX` Default channel suffix

Constructor Summary

Constructors
Constructor and Description

AbstractServer()
Default constructor using endpoint configuration.

Constructors
Constructor and Description
`AbstractServer()` Default constructor using endpoint configuration.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`Consumer`	`createConsumer()` Creates a message consumer for this endpoint.
`Producer`	`createProducer()` Creates a message producer for this endpoint for sending messages to this endpoint.
`void`	`destroy()`
`org.springframework.beans.factory.BeanFactory`	`getBeanFactory()` Gets the Spring bean factory.
`long`	`getDefaultTimeout()` Gets the defaultTimeout for sending and receiving messages.
`EndpointAdapter`	`getEndpointAdapter()` Gets the message endpoint adapter.
`EndpointConfiguration`	`getEndpointConfiguration()` Gets the endpoint configuration holding all endpoint specific properties such as endpoint uri, connection timeout, ports, etc.
`List<Object>`	`getInterceptors()` Gets the handler interceptors.
`boolean`	`isAutoStart()` Gets the autoStart.
`boolean`	`isRunning()` Is server running.
`void`	`join()` Join server thread.
`void`	`run()` Subclasses may overwrite this method in order to add special execution logic.
`void`	`setAutoStart(boolean autoStart)` Enable/disable server auto start
`void`	`setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)` Sets the Spring bean factory.
`void`	`setDefaultTimeout(long defaultTimeout)` Sets the defaultTimeout for sending and receiving messages..
`void`	`setEndpointAdapter(EndpointAdapter endpointAdapter)` Sets the message endpoint adapter.
`void`	`setInterceptors(List<Object> interceptors)` Sets the handler interceptors.
`void`	`setRunning(boolean running)` Sets the running.
`protected abstract void`	`shutdown()` Subclasses must implement this method called on server shutdown.
`void`	`start()` Start the server
`protected abstract void`	`startup()` Subclasses must implement this method called on server startup.
`void`	`stop()` Stop the server.

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

- Field Detail
  - DEFAULT_CHANNEL_ID_SUFFIX
```
public static final String DEFAULT_CHANNEL_ID_SUFFIX
```
    Default channel suffix
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractServer
```
public AbstractServer()
```
    Default constructor using endpoint configuration.
- Method Detail
  - start
```
public void start()
```
    Description copied from interface: Server
    
    Start the server
    
    Specified by:
    
    start in interface Server
    
    See Also:
    
    Server.start()
  - stop
```
public void stop()
```
    Description copied from interface: Server
    
    Stop the server.
    
    Specified by:
    
    stop in interface Server
    
    See Also:
    
    Server.stop()
  - run
```
public void run()
```
    Subclasses may overwrite this method in order to add special execution logic.
    
    Specified by:
    
    run in interface Runnable
  - startup
```
protected abstract void startup()
```
    Subclasses must implement this method called on server startup.
  - shutdown
```
protected abstract void shutdown()
```
    Subclasses must implement this method called on server shutdown.
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception
    
    See Also:
    
    InitializingBean.afterPropertiesSet()
  - destroy
```
public void destroy()
             throws Exception
```
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
    
    Throws:
    
    Exception
    
    See Also:
    
    DisposableBean.destroy()
  - join
```
public void join()
```
    Join server thread.
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: Server
    
    Is server running.
    
    Specified by:
    
    isRunning in interface Server
    
    Returns:
    
    See Also:
    
    Server.isRunning()
  - getEndpointConfiguration
```
public EndpointConfiguration getEndpointConfiguration()
```
    Description copied from interface: Endpoint
    
    Gets the endpoint configuration holding all endpoint specific properties such as endpoint uri, connection timeout, ports, etc.
    
    Specified by:
    
    getEndpointConfiguration in interface Endpoint
    
    Overrides:
    
    getEndpointConfiguration in class AbstractEndpoint
    
    Returns:
  - createConsumer
```
public Consumer createConsumer()
```
    Description copied from interface: Endpoint
    
    Creates a message consumer for this endpoint. Consumer receives messages on this endpoint.
    
    Specified by:
    
    createConsumer in interface Endpoint
    
    Returns:
  - createProducer
```
public Producer createProducer()
```
    Description copied from interface: Endpoint
    
    Creates a message producer for this endpoint for sending messages to this endpoint.
    
    Specified by:
    
    createProducer in interface Endpoint
  - setAutoStart
```
public void setAutoStart(boolean autoStart)
```
    Enable/disable server auto start
    
    Parameters:
    
    autoStart - the autoStart to set
  - isAutoStart
```
public boolean isAutoStart()
```
    Gets the autoStart.
    
    Returns:
    
    the autoStart
  - setRunning
```
public void setRunning(boolean running)
```
    Sets the running.
    
    Parameters:
    
    running - the running to set
  - getBeanFactory
```
public org.springframework.beans.factory.BeanFactory getBeanFactory()
```
    Gets the Spring bean factory.
    
    Returns:
  - setBeanFactory
```
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
```
    Sets the Spring bean factory.
    
    Specified by:
    
    setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware
    
    Parameters:
    
    beanFactory -
  - getEndpointAdapter
```
public EndpointAdapter getEndpointAdapter()
```
    Gets the message endpoint adapter.
    
    Returns:
  - setEndpointAdapter
```
public void setEndpointAdapter(EndpointAdapter endpointAdapter)
```
    Sets the message endpoint adapter.
    
    Parameters:
    
    endpointAdapter -
  - getInterceptors
```
public List<Object> getInterceptors()
```
    Gets the handler interceptors.
    
    Returns:
  - setInterceptors
```
public void setInterceptors(List<Object> interceptors)
```
    Sets the handler interceptors.
    
    Parameters:
    
    interceptors -
  - getDefaultTimeout
```
public long getDefaultTimeout()
```
    Gets the defaultTimeout for sending and receiving messages.
    
    Returns:
  - setDefaultTimeout
```
public void setDefaultTimeout(long defaultTimeout)
```
    Sets the defaultTimeout for sending and receiving messages..
    
    Parameters:
    
    defaultTimeout -

Class AbstractServer

Field Summary

Constructor Summary

Method Summary

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

Field Detail

DEFAULT_CHANNEL_ID_SUFFIX

Constructor Detail

AbstractServer

Method Detail

start

stop

run

startup

shutdown

afterPropertiesSet

destroy

join

isRunning

getEndpointConfiguration

createConsumer

createProducer

setAutoStart

isAutoStart

setRunning

getBeanFactory

setBeanFactory

getEndpointAdapter

setEndpointAdapter

getInterceptors

setInterceptors

getDefaultTimeout

setDefaultTimeout