HttpServerConfig (Bridje HTTP 0.5.0-rc5 API)

java.lang.Object
- org.bridje.http.config.HttpServerConfig

public class HttpServerConfig
extends Object

HTTP server configuration.

Constructor Summary

Constructors
Constructor and Description

HttpServerConfig()

Constructors
Constructor and Description
`HttpServerConfig()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InetSocketAddress`	`createInetSocketAddress()` Creates the InetSocketAddress to be user by the server.
`SSLContext`	`createSSLContext()` Creates a new SSLContext from the parameters of this configuration, that can be use for the SSL codec of the HTTP server.
`String`	`getKeyStoreAlgo()` The algorithm for the KeyManagerFactory.
`String`	`getKeyStoreFile()` The file that holds the key store for the SSLContext.
`String`	`getKeyStorePass()` The password for the key store file.
`String`	`getKeyStoreType()` The KeyStore type to create for the SSLContext.
`String`	`getListen()` The listen IP on witch to start the HTTP server, can be null witch means all IPs will be allowed.
`String`	`getName()` The HTTP server name, by default it will be "Bridje HTTP Server" but you can change that setting this property.
`int`	`getPort()` The port on witch the HTTP server will listen for new connections.
`String`	`getSslAlgo()` The algorithm to use to create the SSLContext.
`boolean`	`isSsl()` Gets if the server must run with SSL connector for HTTPs, if this parameter is true, the SSL parameters must be configure properly for the server to start.
`static HttpServerConfig`	`load(VFile xmlFile)` Loads a HttpServerConfig from a file.
`static void`	`save(OutputStream os, HttpServerConfig object)` Save a SipServerConfig to an output stream.
`void`	`setKeyStoreAlgo(String keyStoreAlgo)` The algorithm for the KeyManagerFactory.
`void`	`setKeyStoreFile(String keyStoreFile)` The file that holds the key store for the SSLContext.
`void`	`setKeyStorePass(String keyStorePass)` The password for the key store file.
`void`	`setKeyStoreType(String keyStoreType)` The KeyStore type to create for the SSLContext.
`void`	`setListen(String listen)` The host on witch to start the HTTP server, can be null witch means all IPs will be allowed.
`void`	`setName(String name)` The HTTP server name, by default it will be "Bridje HTTP Server" but you can change that setting this property.
`void`	`setPort(int port)` The port on witch the HTTP server will listen for new connections.
`void`	`setSsl(boolean ssl)` Gets if the server must run with SSL connector for HTTPs, if this parameter is true, the SSL parameters must be configure properly for the server to start.
`void`	`setSslAlgo(String sslAlgo)` The algorithm to use to create the SSLContext.

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

- Constructor Detail
  - HttpServerConfig
```
public HttpServerConfig()
```
- Method Detail
  - getListen
```
public String getListen()
```
    The listen IP on witch to start the HTTP server, can be null witch means all IPs will be allowed. Specify this only if you plan to restrict the IP on witch the server will accept new connections.
    
    Returns:
    
    The listen for the HTTP server.
  - setListen
```
public void setListen(String listen)
```
    The host on witch to start the HTTP server, can be null witch means all IPs will be allowed. Specify this only if you plan to restrict the IP on witch the server will accept new connections.
    
    Parameters:
    
    listen - The host for the HTTP server.
  - getName
```
public String getName()
```
    The HTTP server name, by default it will be "Bridje HTTP Server" but you can change that setting this property.
    
    Returns:
    
    The name of the HTTP server.
  - setName
```
public void setName(String name)
```
    The HTTP server name, by default it will be "Bridje HTTP Server" but you can change that setting this property.
    
    Parameters:
    
    name - The name of the HTTP server.
  - getPort
```
public int getPort()
```
    The port on witch the HTTP server will listen for new connections. By default 8080
    
    Returns:
    
    The HTTP server port
  - setPort
```
public void setPort(int port)
```
    The port on witch the HTTP server will listen for new connections. By default 8080
    
    Parameters:
    
    port - The HTTP server port
  - isSsl
```
public boolean isSsl()
```
    Gets if the server must run with SSL connector for HTTPs, if this parameter is true, the SSL parameters must be configure properly for the server to start.
    
    Returns:
    
    true SSL is enabled, false SSL is disabled.
  - setSsl
```
public void setSsl(boolean ssl)
```
    Gets if the server must run with SSL connector for HTTPs, if this parameter is true, the SSL parameters must be configure properly for the server to start.
    
    Parameters:
    
    ssl - true SSL is enabled, false SSL is disabled.
  - getSslAlgo
```
public String getSslAlgo()
```
    The algorithm to use to create the SSLContext.
    Note that the list of registered providers may be retrieved via the Security.getProviders() method.
    
    Returns:
    
    The algorithm that will be use to create the SSLContext.
  - setSslAlgo
```
public void setSslAlgo(String sslAlgo)
```
    The algorithm to use to create the SSLContext.
    Note that the list of registered providers may be retrieved via the Security.getProviders() method.
    
    Parameters:
    
    sslAlgo - The algorithm that will be use to create the SSLContext.
  - getKeyStoreFile
```
public String getKeyStoreFile()
```
    The file that holds the key store for the SSLContext.
    
    Returns:
    
    An String with the path relative to the current folder for the key store file.
  - setKeyStoreFile
```
public void setKeyStoreFile(String keyStoreFile)
```
    The file that holds the key store for the SSLContext.
    
    Parameters:
    
    keyStoreFile - An String with the path relative to the current folder for the key store file.
  - getKeyStorePass
```
public String getKeyStorePass()
```
    The password for the key store file.
    
    Returns:
    
    The password for the key store file.
  - setKeyStorePass
```
public void setKeyStorePass(String keyStorePass)
```
    The password for the key store file.
    
    Parameters:
    
    keyStorePass - The password for the key store file.
  - getKeyStoreType
```
public String getKeyStoreType()
```
    The KeyStore type to create for the SSLContext.
    
    Returns:
    
    The KeyStore type to create for the SSLContext.
  - setKeyStoreType
```
public void setKeyStoreType(String keyStoreType)
```
    The KeyStore type to create for the SSLContext.
    
    Parameters:
    
    keyStoreType - The KeyStore type to create for the SSLContext.
  - getKeyStoreAlgo
```
public String getKeyStoreAlgo()
```
    The algorithm for the KeyManagerFactory.
    
    Returns:
    
    The algorithm for the KeyManagerFactory.
  - setKeyStoreAlgo
```
public void setKeyStoreAlgo(String keyStoreAlgo)
```
    The algorithm for the KeyManagerFactory.
    
    Parameters:
    
    keyStoreAlgo - The algorithm for the KeyManagerFactory.
  - createInetSocketAddress
```
public InetSocketAddress createInetSocketAddress()
```
    Creates the InetSocketAddress to be user by the server.
    
    Returns:
    
    A new InetSocketAddress instance
  - createSSLContext
```
public SSLContext createSSLContext()
                            throws NoSuchAlgorithmException,
                                   KeyStoreException,
                                   IOException,
                                   UnrecoverableKeyException,
                                   CertificateException,
                                   KeyManagementException
```
    Creates a new SSLContext from the parameters of this configuration, that can be use for the SSL codec of the HTTP server.
    
    Returns:
    
    The new created SSLContext for the HTTP server SSL codec.
    
    Throws:
    
    NoSuchAlgorithmException - If a wrong algorithm is provided.
    
    KeyStoreException - If any error occurs with the KeyStore.
    
    IOException - If the key store file is not found or cannot be read.
    
    UnrecoverableKeyException - This exception is thrown if a key in the key store cannot be recovered.
    
    CertificateException - This exception indicates one of a variety of certificate problems.
    
    KeyManagementException - This is the general key management exception for all operations dealing with key management.
  - load
```
public static HttpServerConfig load(VFile xmlFile)
                             throws JAXBException,
                                    IOException
```
    Loads a HttpServerConfig from a file.
    
    Parameters:
    
    xmlFile - The file to load the object from.
    
    Returns:
    
    The loaded object.
    
    Throws:
    
    JAXBException - If any JAXB Exception occurs.
    
    IOException - If any IO Exception occurs.
  - save
```
public static void save(OutputStream os,
                        HttpServerConfig object)
                 throws JAXBException
```
    Save a SipServerConfig to an output stream.
    
    Parameters:
    
    os - The output stream to write the object to.
    
    object - The object to write.
    
    Throws:
    
    JAXBException - If any JAXB Exception occurs.

Class HttpServerConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpServerConfig

Method Detail

getListen

setListen

getName

setName

getPort

setPort

isSsl

setSsl

getSslAlgo

setSslAlgo

getKeyStoreFile

setKeyStoreFile

getKeyStorePass

setKeyStorePass

getKeyStoreType

setKeyStoreType

getKeyStoreAlgo

setKeyStoreAlgo

createInetSocketAddress

createSSLContext

load

save