org.ow2.petals.binding.soap.listener.incoming
Class SoapServerConfig

java.lang.Object
  org.ow2.petals.binding.soap.listener.incoming.SoapServerConfig

public class SoapServerConfig
extends Object

This class is used to store only the SOAP server related configuration values.

Author:

Christophe HAMERLING - eBMWebSourcing

Field Summary

protected int	jettyAcceptors The number of acceptors
protected int	jettyThreadMaxPoolSize The thread pool maximum size
protected int	jettyThreadMinPoolSize The thread pool minimum size
protected String	servicesURL
protected String	wsnContext
protected String	wsnProducerMapping
protected String	wsnProducerURL

Constructor Summary

SoapServerConfig()
Creates a new instance of SoapServerConfig

Method Summary

void	addRedirect(String from, String to) Define a HTTP redirection (to customize URLs)
String	getBaseURL()
String	getBaseURL(String transport)
org.apache.axis2.addressing.EndpointReference[]	getEPRsForAxisService(String serviceName, String transport) Get the EPRs for the specified Axis service name and protocol
String	getHostAddress() Return the HTTP/HTTPS host name
String	getHostToDisplay() Return the HTTP/HTTPS host name (to display)
int	getHttpPort()
String	getHttpsKeystoreFile() Get the keystore file path
String	getHttpsKeystoreKeyPassword() Get the key password
String	getHttpsKeystorePassword() Get the keystore password
String	getHttpsKeystoreType() Get the keystore type (JKS / PKCS12)
int	getHttpsPort()
String	getHttpsTruststoreFile() Get the truststore file path
String	getHttpsTruststorePassword() Get the truststore password
String	getHttpsTruststoreType() Get the truststore type (JKS / PKCS12)
int	getJettyAcceptors()
int	getJettyThreadMaxPoolSize()
int	getJettyThreadMinPoolSize()
String	getRedirect(String from)
String	getServicesContext()
String	getServicesMapping()
String	getServicesURL(String transport) Get the URL of the base URL for the services
String	getServiceURL(String serviceName, String transport) Get the URL of the service for the specified service name and protocol
void	initTransportListenerForAxis(org.apache.axis2.description.TransportInDescription transprtInDesc, String transport) Initialize the transport description for Axis
boolean	isHttpsClientAuthEnabled() Return if HTTPS client authentication is enabled
boolean	isHttpsEnabled() Return if HTTPS is enabled
boolean	isProvidesList()
boolean	isRestricted() Return if the HTTP/HTTPS server is configured to listen to only one interface or not
boolean	isValidHostName() Return if the host is valid
void	removeRedirect(String from)
void	setHost(Logger logger, String host) Validate the specified host and add it ti the server configuration
void	setHttpPort(int port)
void	setHttpsClientAuthEnabled(boolean isHttpsClientAuthEnabled) Define if HTTPS client authentication is enabled
void	setHttpsEnabled(boolean isHttpsEnabled) Define if HTTPS is enabled
void	setHttpsKeyPassword(String httpsKeytoreKeyPassword) Set the key password
void	setHttpsKeytoreFile(String httpsKeytoreFile) Set the keystore absolute file path
void	setHttpsKeytorePassword(String httpsKeytorePassword) Set the keystore password
void	setHttpsKeytoreType(String httpsKeystoreType) Set the type of the keystore (JKS / PKCS12)
void	setHttpsPort(int port)
void	setHttpsTruststoreFile(String httpsTruststoreFile) Set the truststore absolute file path
void	setHttpsTruststorePassword(String httpsTruststorePassword) Set the truststore password
void	setHttpsTruststoreType(String httpsTruststoreType) Set the type of the truststore (JKS / PKCS12)
void	setJettyAcceptors(int jettyAcceptors)
void	setJettyThreadMaxPoolSize(int jettyThreadMaxPoolSize)
void	setJettyThreadMinPoolSize(int jettyThreadMinPoolSize)
void	setProvidesList(boolean providesList)
void	setRestrict(boolean restrict)
void	setServicesContext(String servicesContext)
void	setServicesMapping(String servicesMapping)

Methods inherited from class java.lang.Object

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

Field Detail

jettyThreadMaxPoolSize

protected int jettyThreadMaxPoolSize

The thread pool maximum size

jettyThreadMinPoolSize

protected int jettyThreadMinPoolSize

The thread pool minimum size

jettyAcceptors

protected int jettyAcceptors

The number of acceptors

wsnContext

protected String wsnContext

wsnProducerMapping

protected String wsnProducerMapping

wsnProducerURL

protected String wsnProducerURL

servicesURL

protected String servicesURL

Constructor Detail

SoapServerConfig

public SoapServerConfig()

Creates a new instance of SoapServerConfig

Method Detail

setHost

public void setHost(Logger logger,
                    String host)

Validate the specified host and add it ti the server configuration

Parameters:

config - the server configuration

isValidHostName

public boolean isValidHostName()

Return if the host is valid

Returns:

true if the host is valid, otherwise false

isRestricted

public boolean isRestricted()

Return if the HTTP/HTTPS server is configured to listen to only one interface or not

Returns:

true if the HTTP/HTTPS server listens to only one interface, otherwise false

getHostAddress

public String getHostAddress()

Return the HTTP/HTTPS host name

Returns:

the HTTP/HTTPS host name

getHostToDisplay

public String getHostToDisplay()

Return the HTTP/HTTPS host name (to display)

Returns:

the HTTP/HTTPS host name (to display)

getJettyAcceptors

public int getJettyAcceptors()

Returns:

the jettyAcceptors

getJettyThreadMaxPoolSize

public int getJettyThreadMaxPoolSize()

Returns:

the jettyThreadMaxPoolSize

getJettyThreadMinPoolSize

public int getJettyThreadMinPoolSize()

Returns:

the jettyThreadMinPoolSize

getHttpPort

public int getHttpPort()

Returns:

the HTTP port

getHttpsPort

public int getHttpsPort()

Returns:

the HTTPS port

getServicesContext

public String getServicesContext()

Returns:

the servicesContext

getServicesMapping

public String getServicesMapping()

Returns:

the servicesMapping

isProvidesList

public boolean isProvidesList()

Returns:

the providesList

isHttpsEnabled

public boolean isHttpsEnabled()

Return if HTTPS is enabled

Returns:

true if HTTPS is enabled, otherwise false

isHttpsClientAuthEnabled

public boolean isHttpsClientAuthEnabled()

Return if HTTPS client authentication is enabled

Returns:

true if HTTPS client authentication is enabled, otherwise false

getHttpsKeystoreType

public String getHttpsKeystoreType()

Get the keystore type (JKS / PKCS12)

Returns:

the keystore type (JKS / PKCS12)

getHttpsKeystoreFile

public String getHttpsKeystoreFile()

Get the keystore file path

Returns:

the keystore file path

getHttpsKeystorePassword

public String getHttpsKeystorePassword()

Get the keystore password

Returns:

the keystore password

getHttpsKeystoreKeyPassword

public String getHttpsKeystoreKeyPassword()

Get the key password

Returns:

the key password

getHttpsTruststoreType

public String getHttpsTruststoreType()

Get the truststore type (JKS / PKCS12)

Returns:

the truststore type (JKS / PKCS12)

getHttpsTruststoreFile

public String getHttpsTruststoreFile()

Get the truststore file path

Returns:

the truststore file path

getHttpsTruststorePassword

public String getHttpsTruststorePassword()

Get the truststore password

Returns:

the truststore password

setJettyAcceptors

public void setJettyAcceptors(int jettyAcceptors)

Parameters:

jettyAcceptors - the jettyAcceptors to set

setJettyThreadMaxPoolSize

public void setJettyThreadMaxPoolSize(int jettyThreadMaxPoolSize)

Parameters:

jettyThreadMaxPoolSize - the jettyThreadMaxPoolSize to set

setJettyThreadMinPoolSize

public void setJettyThreadMinPoolSize(int jettyThreadMinPoolSize)

Parameters:

jettyThreadMinPoolSize - the jettyThreadMinPoolSize to set

setHttpPort

public void setHttpPort(int port)

Parameters:

HTTP - port the HTTP port to set

setHttpsPort

public void setHttpsPort(int port)

Parameters:

HTTPS - port the HTTPS port to set

setProvidesList

public void setProvidesList(boolean providesList)

Parameters:

providesList - the providesList to set

setRestrict

public void setRestrict(boolean restrict)

Parameters:

restrict - the restrict to set

setServicesContext

public void setServicesContext(String servicesContext)

Parameters:

servicesContext - the servicesContext to set

setServicesMapping

public void setServicesMapping(String servicesMapping)

Parameters:

servicesMapping - the servicesMapping to set

setHttpsEnabled

public void setHttpsEnabled(boolean isHttpsEnabled)

Define if HTTPS is enabled

Parameters:

isHttpsEnabled - a flag set to true if HTTPS is enabled, otherwise false

setHttpsClientAuthEnabled

public void setHttpsClientAuthEnabled(boolean isHttpsClientAuthEnabled)

Define if HTTPS client authentication is enabled

Parameters:

isHttpsClientAuthEnabled - a flag set to true if HTTPS client authentication is enabled, otherwise false

setHttpsKeytoreType

public void setHttpsKeytoreType(String httpsKeystoreType)

Set the type of the keystore (JKS / PKCS12)

Parameters:

httpsKeystoreType - the type of the keystore (JKS / PKCS12)

setHttpsKeytoreFile

public void setHttpsKeytoreFile(String httpsKeytoreFile)

Set the keystore absolute file path

Parameters:

httpsKeytoreFile - the keystore absolute file path

setHttpsKeytorePassword

public void setHttpsKeytorePassword(String httpsKeytorePassword)

Set the keystore password

Parameters:

httpsKeytorePassword - the keystore password

setHttpsKeyPassword

public void setHttpsKeyPassword(String httpsKeytoreKeyPassword)

Set the key password

Parameters:

httpsKeytoreKeyPassword - the key password

setHttpsTruststoreType

public void setHttpsTruststoreType(String httpsTruststoreType)

Set the type of the truststore (JKS / PKCS12)

Parameters:

httpsTruststoreType - the type of the truststore (JKS / PKCS12)

setHttpsTruststoreFile

public void setHttpsTruststoreFile(String httpsTruststoreFile)

Set the truststore absolute file path

Parameters:

httpsTruststoreFile - the truststore absolute file path

setHttpsTruststorePassword

public void setHttpsTruststorePassword(String httpsTruststorePassword)

Set the truststore password

Parameters:

httpsTruststorePassword - the truststore password

getEPRsForAxisService

public org.apache.axis2.addressing.EndpointReference[] getEPRsForAxisService(String serviceName,
                                                                             String transport)
                                                                      throws org.apache.axis2.AxisFault

Get the EPRs for the specified Axis service name and protocol

Parameters:

serviceName - the Axis service name

protocol - the protocol

axisConfigurationContext - the Axis 2 configuration

Returns:

the endpoint reference for the specified Axis service and protocol

Throws:

org.apache.axis2.AxisFault

getServiceURL

public String getServiceURL(String serviceName,
                            String transport)

Get the URL of the service for the specified service name and protocol

Parameters:

serviceName - the Axis service name

transport - the transport

Returns:

the URL of the service

getServicesURL

public String getServicesURL(String transport)

Get the URL of the base URL for the services

Parameters:

transport - the transport

Returns:

initTransportListenerForAxis

public void initTransportListenerForAxis(org.apache.axis2.description.TransportInDescription transprtInDesc,
                                         String transport)
                                  throws org.apache.axis2.AxisFault

Initialize the transport description for Axis

Parameters:

transprtInDesc - the transport description

port - the port to use to initialize the transport description

Throws:

org.apache.axis2.AxisFault

addRedirect

public void addRedirect(String from,
                        String to)

Define a HTTP redirection (to customize URLs)

Parameters:

from - Original URI

to - Destination URI

getRedirect

public String getRedirect(String from)

removeRedirect

public void removeRedirect(String from)

getBaseURL

public String getBaseURL()

getBaseURL

public String getBaseURL(String transport)