QuickServer
v1.4.7

org.quickserver.util.xmlreader
Class Secure

java.lang.Object
  extended byorg.quickserver.util.xmlreader.Secure
All Implemented Interfaces:
java.io.Serializable

public class Secure
extends java.lang.Object
implements java.io.Serializable

This class encapsulate the setting that help in configuring a secure socket based QuickServer. The example xml is

        ....
        <secure>
                <enable>true</enable>
                <load>true</load>
                <port></port>
                <protocol>TLS</protocol>
                <client-auth-enable>false</client-auth-enable> 
                <secure-store>
                        ....
                </secure-store>
        </secure>
        ....
 

Since:
1.4
Author:
Akshathkumar Shetty
See Also:
TrustStoreInfo, KeyStoreInfo, SecureStore, Serialized Form

Constructor Summary
Secure()
           
 
Method Summary
 boolean getClientAuthEnable()
          Returns whether the connections which are accepted must include successful client authentication.
 boolean getEnable()
          Returns the Secure enable flag.
 boolean getLoad()
          Returns the load flag for SSLContext.
 int getPort()
          Returns the port for the QuickServer to listen on in secure mode.
 java.lang.String getProtocol()
          Returns the protocol for the QuickServer to listen on in secure mode.
 SecureStore getSecureStore()
          Returns SecureStore information.
 boolean isClientAuthEnable()
          Returns whether the connections which are accepted must include successful client authentication.
 boolean isEnable()
          Returns the Secure enable flag.
 boolean isLoad()
          Returns the load flag for SSLContext.
 void setClientAuthEnable(boolean enable)
          Sets whether the connections which are accepted must include successful client authentication.
 void setEnable(boolean enable)
          Sets the Secure enable flag.
 void setLoad(boolean load)
          Sets the load flag for SSLContext.
 void setPort(int port)
          Sets the port for the QuickServer to listen on in secure mode.
 void setProtocol(java.lang.String protocol)
          Sets the protocol for the QuickServer to listen on in secure mode.
 void setSecureStore(SecureStore secureStore)
          Sets SecureStore information XML Tag: <secure-store></secure-store>
 java.lang.String toXML(java.lang.String pad)
          Returns XML config of this class.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Secure

public Secure()
Method Detail

setEnable

public void setEnable(boolean enable)
Sets the Secure enable flag. If not set, it will use false
XML Tag: <secure><enable>true</enable></secure> Allowed values = true | false If enable is set to true load is also set to true.

See Also:
getEnable()

getEnable

public boolean getEnable()
Returns the Secure enable flag.

See Also:
setEnable(boolean)

isEnable

public boolean isEnable()
Returns the Secure enable flag.


setLoad

public void setLoad(boolean load)
Sets the load flag for SSLContext. If not set, it will use false
XML Tag: <Secure><load>true</load></Secure> Allowed values = true | false

See Also:
getLoad()

getLoad

public boolean getLoad()
Returns the load flag for SSLContext.

See Also:
setLoad(boolean)

isLoad

public boolean isLoad()
Returns the load flag for SSLContext.


setPort

public void setPort(int port)
Sets the port for the QuickServer to listen on in secure mode. If not set, it will run on servers non secure port
XML Tag: <port></port>

Parameters:
port - to listen on.
See Also:
getPort()

getPort

public int getPort()
Returns the port for the QuickServer to listen on in secure mode.

See Also:
setPort(int)

setProtocol

public void setProtocol(java.lang.String protocol)
Sets the protocol for the QuickServer to listen on in secure mode. If not set, it will use TLS
XML Tag: <protocol>TLS</protocol>

Parameters:
protocol - to listen on in secure mode.
See Also:
getProtocol()

getProtocol

public java.lang.String getProtocol()
Returns the protocol for the QuickServer to listen on in secure mode.

See Also:
setProtocol(java.lang.String)

setClientAuthEnable

public void setClientAuthEnable(boolean enable)
Sets whether the connections which are accepted must include successful client authentication. If not set, it will use false
XML Tag: <client-auth-enable>false</client-auth-enable>

Parameters:
enable - client authentication enable flag
See Also:
getClientAuthEnable()

getClientAuthEnable

public boolean getClientAuthEnable()
Returns whether the connections which are accepted must include successful client authentication.

See Also:
setClientAuthEnable(boolean)

isClientAuthEnable

public boolean isClientAuthEnable()
Returns whether the connections which are accepted must include successful client authentication.


setSecureStore

public void setSecureStore(SecureStore secureStore)
Sets SecureStore information XML Tag: <secure-store></secure-store>

Parameters:
secureStore - SecureStore information
See Also:
getSecureStore()

getSecureStore

public SecureStore getSecureStore()
Returns SecureStore information.

See Also:
setSecureStore(org.quickserver.util.xmlreader.SecureStore)

toXML

public java.lang.String toXML(java.lang.String pad)
Returns XML config of this class.


QuickServer
v1.4.7

Copyright © 2003-2006 QuickServer.org