Author: pferraro Date: 2008-11-12 19:00:27 -0500 (Wed, 12 Nov 2008) New Revision: 2060 Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/BalancerConfiguration.java trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/MCMPHandlerConfiguration.java trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/ModClusterConfig.java trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/NodeConfiguration.java trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/SSLConfiguration.java Log: Moved javadocs to interfaces Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/BalancerConfiguration.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/BalancerConfiguration.java 2008-11-06 12:48:17 UTC (rev 2059) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/BalancerConfiguration.java 2008-11-13 00:00:27 UTC (rev 2060) @@ -28,13 +28,28 @@ */ public interface BalancerConfiguration { + /** + * Enables sticky sessions. + */ boolean getStickySession(); + /** + * Remove session when the request cannot be routed to the right node. + */ boolean getStickySessionRemove(); + /** + * Return an error when the request cannot be routed to the right node. + */ boolean getStickySessionForce(); + /** + * Timeout to wait for an available worker (default is no wait). + */ int getWorkerTimeout(); + /** + * Maximum number of attempts to send the request to the backend server. + */ int getMaxAttempts(); } Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/MCMPHandlerConfiguration.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/MCMPHandlerConfiguration.java 2008-11-06 12:48:17 UTC (rev 2059) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/MCMPHandlerConfiguration.java 2008-11-13 00:00:27 UTC (rev 2060) @@ -30,21 +30,49 @@ */ public interface MCMPHandlerConfiguration extends SSLConfiguration { + /** + * Proxy list, format "address:port,address:port". + */ String getProxyList(); + /** + * URL prefix. + */ String getProxyURL(); - + + /** + * Connection timeout for communication with the proxy. + */ int getSocketTimeout(); + /** + * SSL client cert usage to connect to the proxy. + */ boolean isSsl(); + /** + * Receive advertisements from httpd proxies (default is to use advertisements + * if the proxyList is not set). + */ Boolean getAdvertise(); - + + /** + * Advertise group. + */ String getAdvertiseGroupAddress(); - + + /** + * Advertise port. + */ int getAdvertisePort(); - + + /** + * Advertise security key. + */ String getAdvertiseSecurityKey(); + /** + * Should clustered service use a singleton master per domain. + */ boolean isMasterPerDomain(); } Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/ModClusterConfig.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/ModClusterConfig.java 2008-11-06 12:48:17 UTC (rev 2059) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/ModClusterConfig.java 2008-11-13 00:00:27 UTC (rev 2060) @@ -38,195 +38,101 @@ { // ----------------------------------------------- MCMPHandlerConfiguration - /** - * Receive advertisements from httpd proxies (default is to use advertisements - * if the proxyList is not set). - */ private Boolean advertise; public Boolean getAdvertise() { return this.advertise; } public void setAdvertise(Boolean advertise) { this.advertise = advertise; } - - /** - * Advertise group. - */ private String advertiseGroupAddress = null; public String getAdvertiseGroupAddress() { return this.advertiseGroupAddress; } public void setAdvertiseGroupAddress(String advertiseGroupAddress) { this.advertiseGroupAddress = advertiseGroupAddress; } - - /** - * Advertise port. - */ private int advertisePort = -1; public int getAdvertisePort() { return this.advertisePort; } public void setAdvertisePort(int advertisePort) { this.advertisePort = advertisePort; } - - /** - * Advertise security key. - */ private String advertiseSecurityKey = null; public String getAdvertiseSecurityKey() { return this.advertiseSecurityKey; } public void setAdvertiseSecurityKey(String advertiseSecurityKey) { this.advertiseSecurityKey = advertiseSecurityKey; } - - /** - * Proxy list, format "address:port,address:port". - */ private String proxyList = null; public String getProxyList() { return this.proxyList; } public void setProxyList(String proxyList) { this.proxyList = proxyList; } - - /** - * URL prefix. - */ private String proxyURL = null; public String getProxyURL() { return this.proxyURL; } public void setProxyURL(String proxyURL) { this.proxyURL = proxyURL; } - - /** - * Connection timeout for communication with the proxy. - */ private int socketTimeout = 20000; public int getSocketTimeout() { return this.socketTimeout; } public void setSocketTimeout(int socketTimeout) { this.socketTimeout = socketTimeout; } - /** - * Should clustered service use a singleton master per domain. - */ + private boolean ssl = false; + public boolean isSsl() { return this.ssl; } + public void setSsl(boolean ssl) { this.ssl = ssl; } + private boolean masterPerDomain = false; public boolean isMasterPerDomain() { return this.masterPerDomain; } public void setMasterPerDomain(boolean masterPerDomain) { this.masterPerDomain = masterPerDomain; } // ----------------------------------------------------- SSLConfiguration - - /** - * SSL client cert usage to connect to the proxy. - */ - private boolean ssl = false; - public boolean isSsl() { return this.ssl; } - public void setSsl(boolean ssl) { this.ssl = ssl; } - - /** - * SSL ciphers. - */ private String sslCiphers = null; public String getSslCiphers() { return this.sslCiphers; } public void setSslCiphers(String sslCiphers) { this.sslCiphers = sslCiphers; } - - /** - * SSL protocol. - */ private String sslProtocol = "TLS"; public String getSslProtocol() { return this.sslProtocol; } public void setSslProtocol(String sslProtocol) { this.sslProtocol = sslProtocol; } - - /** - * Certificate encoding algorithm. - */ private String sslCertificateEncodingAlgorithm = KeyManagerFactory.getDefaultAlgorithm(); public String getSslCertificateEncodingAlgorithm() { return this.sslCertificateEncodingAlgorithm; } public void setSslCertificateEncodingAlgorithm(String sslCertificateEncodingAlgorithm) { this.sslCertificateEncodingAlgorithm = sslCertificateEncodingAlgorithm; } - - /** - * SSL keystore. - */ private String sslKeyStore = System.getProperty("user.home") + "/.keystore"; public String getSslKeyStore() { return this.sslKeyStore; } public void setSslKeyStore(String sslKeyStore) { this.sslKeyStore = sslKeyStore; } - - /** - * SSL keystore password. - */ private String sslKeyStorePass = "changeit"; public String getSslKeyStorePass() { return this.sslKeyStorePass; } public void setSslKeyStorePass(String sslKeyStorePass) { this.sslKeyStorePass = sslKeyStorePass; } - - /** - * Keystore type. - */ private String sslKeyStoreType = "JKS"; public String getSslKeyStoreType() { return this.sslKeyStoreType; } public void setSslKeyStoreType(String sslKeyStoreType) { this.sslKeyStoreType = sslKeyStoreType; } - - /** - * Keystore provider. - */ private String sslKeyStoreProvider = null; public String getSslKeyStoreProvider() { return this.sslKeyStoreProvider; } public void setSslKeyStoreProvider(String sslKeyStoreProvider) { this.sslKeyStoreProvider = sslKeyStoreProvider; } - - /** - * Truststore algorithm. - */ private String sslTrustAlgorithm = TrustManagerFactory.getDefaultAlgorithm(); public String getSslTrustAlgorithm() { return this.sslTrustAlgorithm; } public void setSslTrustAlgorithm(String sslTrustAlgorithm) { this.sslTrustAlgorithm = sslTrustAlgorithm; } - - /** - * Key alias. - */ private String sslKeyAlias = null; public String getSslKeyAlias() { return this.sslKeyAlias; } public void setSslKeyAlias(String sslKeyAlias) { this.sslKeyAlias = sslKeyAlias; } - - /** - * Certificate revocation list. - */ private String sslCrlFile = null; public String getSslCrlFile() { return this.sslCrlFile; } public void setSslCrlFile(String sslCrlFile) { this.sslCrlFile = sslCrlFile; } - - /** - * Trust max certificate length. - */ private int sslTrustMaxCertLength = 5; public int getSslTrustMaxCertLength() { return this.sslTrustMaxCertLength; } public void setSslTrustMaxCertLength(int sslTrustMaxCertLength) { this.sslTrustMaxCertLength = sslTrustMaxCertLength; } - - /** - * Trust store file. - */ private String sslTrustStore = System.getProperty("javax.net.ssl.trustStore"); public String getSslTrustStore() { return this.sslTrustStore; } public void setSslTrustStore(String sslTrustStore) { this.sslTrustStore = sslTrustStore; } - - /** - * Trust store password. - */ private String sslTrustStorePassword = System.getProperty("javax.net.ssl.trustStorePassword"); public String getSslTrustStorePassword() { return this.sslTrustStorePassword; } public void setSslTrustStorePassword(String sslTrustStorePassword) { this.sslTrustStorePassword = sslTrustStorePassword; } - - /** - * Trust store type. - */ private String sslTrustStoreType = System.getProperty("javax.net.ssl.trustStoreType"); public String getSslTrustStoreType() { return this.sslTrustStoreType; } public void setSslTrustStoreType(String sslTrustStoreType) { this.sslTrustStoreType = sslTrustStoreType; } - - /** - * Trust store provider. - */ private String sslTrustStoreProvider = System.getProperty("javax.net.ssl.trustStoreProvider"); public String getSslTrustStoreProvider() { return this.sslTrustStoreProvider; } public void setSslTrustStoreProvider(String sslTrustStoreProvider) { this.sslTrustStoreProvider = sslTrustStoreProvider; } @@ -234,107 +140,56 @@ // ----------------------------------------------------- NodeConfiguration - - /** - * Domain parameter, which allows tying a jvmRoute to a particular domain. - */ private String domain = null; public String getDomain() { return this.domain; } public void setDomain(String domain) { this.domain = domain; } - - /** - * Allows controlling flushing of packets. - */ private boolean flushPackets = false; public boolean getFlushPackets() { return this.flushPackets; } public void setFlushPackets(boolean flushPackets) { this.flushPackets = flushPackets; } - - /** - * Time to wait before flushing packets. - */ private int flushWait = -1; public int getFlushWait() { return this.flushWait; } public void setFlushWait(int flushWait) { this.flushWait = flushWait; } - - /** - * Time to wait for a pong answer to a ping. - */ private int ping = -1; public int getPing() { return this.ping; } public void setPing(int ping) { this.ping = ping; } - - /** - * Soft maximum inactive connection count. - */ private int smax = -1; public int getSmax() { return this.smax; } public void setSmax(int smax) { this.smax = smax; } - - /** - * Maximum time on seconds for idle connections above smax. - */ private int ttl = -1; public int getTtl() { return this.ttl; } public void setTtl(int ttl) { this.ttl = ttl; } - - /** - * Maximum time on seconds for idle connections the proxy will wait to connect to the node. - */ private int nodeTimeout = -1; public int getNodeTimeout() { return this.nodeTimeout; } public void setNodeTimeout(int nodeTimeout) { this.nodeTimeout = nodeTimeout; } - - /** - * Name of the balancer. - */ private String balancer = null; public String getBalancer() { return this.balancer; } public void setBalancer(String balancer) { this.balancer = balancer; } // ------------------------------------------------- BalancerConfiguration - /** - * Enables sticky sessions. - */ private boolean stickySession = true; public boolean getStickySession() { return this.stickySession; } public void setStickySession(boolean stickySession) { this.stickySession = stickySession; } - - /** - * Remove session when the request cannot be routed to the right node. - */ private boolean stickySessionRemove = false; public boolean getStickySessionRemove() { return this.stickySessionRemove; } public void setStickySessionRemove(boolean stickySessionRemove) { this.stickySessionRemove = stickySessionRemove; } - - /** - * Return an error when the request cannot be routed to the right node. - */ private boolean stickySessionForce = true; public boolean getStickySessionForce() { return this.stickySessionForce; } public void setStickySessionForce(boolean stickySessionForce) { this.stickySessionForce = stickySessionForce; } - - /** - * Timeout to wait for an available worker (default is no wait). - */ private int workerTimeout = -1; public int getWorkerTimeout() { return this.workerTimeout; } public void setWorkerTimeout(int workerTimeout) { this.workerTimeout = workerTimeout; } - - /** - * Maximum number of attempts to send the request to the backend server. - */ private int maxAttempts = -1; public int getMaxAttempts() { return this.maxAttempts; } public void setMaxAttempts(int maxAttempts) { this.maxAttempts = maxAttempts; } Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/NodeConfiguration.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/NodeConfiguration.java 2008-11-06 12:48:17 UTC (rev 2059) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/NodeConfiguration.java 2008-11-13 00:00:27 UTC (rev 2060) @@ -26,21 +26,43 @@ public interface NodeConfiguration extends LoadBalanceFactorProvider { - int getSocketTimeout(); - + /** + * Domain parameter, which allows tying a jvmRoute to a particular domain. + */ String getDomain(); + /** + * Allows controlling flushing of packets. + */ boolean getFlushPackets(); + /** + * Time to wait before flushing packets. + */ int getFlushWait(); + /** + * Time to wait for a pong answer to a ping. + */ int getPing(); + /** + * Soft maximum inactive connection count. + */ int getSmax(); + /** + * Maximum time on seconds for idle connections above smax. + */ int getTtl(); + /** + * Maximum time on seconds for idle connections the proxy will wait to connect to the node. + */ int getNodeTimeout(); + /** + * Name of the balancer. + */ String getBalancer(); } \ No newline at end of file Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/SSLConfiguration.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/SSLConfiguration.java 2008-11-06 12:48:17 UTC (rev 2059) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/config/SSLConfiguration.java 2008-11-13 00:00:27 UTC (rev 2060) @@ -30,20 +30,79 @@ */ public interface SSLConfiguration { + /** + * SSL ciphers. + */ String getSslCiphers(); + + /** + * SSL protocol. + */ String getSslProtocol(); + + /** + * Certificate encoding algorithm. + */ String getSslCertificateEncodingAlgorithm(); + + /** + * SSL keystore. + */ String getSslKeyStore(); + + /** + * SSL keystore password. + */ String getSslKeyStorePass(); + + /** + * Keystore type. + */ String getSslKeyStoreType(); + + /** + * Keystore provider. + */ String getSslKeyStoreProvider(); + + /** + * Truststore algorithm. + */ String getSslTrustAlgorithm(); + + /** + * Key alias. + */ String getSslKeyAlias(); + + /** + * Certificate revocation list. + */ String getSslCrlFile(); + + /** + * Trust max certificate length. + */ int getSslTrustMaxCertLength(); + + /** + * Trust store file. + */ String getSslTrustStore(); + + /** + * Trust store password. + */ String getSslTrustStorePassword(); + + /** + * Trust store type. + */ String getSslTrustStoreType(); + + /** + * Trust store provider. + */ String getSslTrustStoreProvider(); }