Author: indika
Date: Tue Jul 8 23:13:12 2008
New Revision: 675102
URL: http://svn.apache.org/viewvc?rev=675102&view=rev
Log:
java docs and logs
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/LoadBalanceMembershipHandler.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/Axis2SynapseEnvironment.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/CipherInformation.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/KeyStoreInformation.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/factory/KeyStoreInformationFactory.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/interfaces/IKeyStoreLoader.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/AbstractKeyStoreLoader.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/CACertsLoader.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/JKSKeyStoreLoader.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS12KeyStoreLoader.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS8KeyStoreLoader.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/CipherWrapper.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/IdentityKeyStoreWrapper.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/KeyStoreWrapper.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/TrustKeyStoreWrapper.java
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/LoadBalanceMembershipHandler.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/LoadBalanceMembershipHandler.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/LoadBalanceMembershipHandler.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/LoadBalanceMembershipHandler.java
Tue Jul 8 23:13:12 2008
@@ -27,7 +27,7 @@
/**
* This interface is responsible for providing the next member to which a
message has to be sent to.
- * Generally, this interface will work with a GCF or other membership
doscovery mechanism
+ * Generally, this interface will work with a GCF or other membership
discovery mechanism
*/
public interface LoadBalanceMembershipHandler {
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/Axis2SynapseEnvironment.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/Axis2SynapseEnvironment.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/Axis2SynapseEnvironment.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/Axis2SynapseEnvironment.java
Tue Jul 8 23:13:12 2008
@@ -294,7 +294,7 @@
/**
* This method returns the StatisticsCollector
*
- * @return Retruns the StatisticsCollector
+ * @return Returns the StatisticsCollector
*/
public StatisticsCollector getStatisticsCollector() {
return statisticsCollector;
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/CipherInformation.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/CipherInformation.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/CipherInformation.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/CipherInformation.java
Tue Jul 8 23:13:12 2008
@@ -30,12 +30,19 @@
private static final Log log = LogFactory.getLog(CipherInformation.class);
+ /* Default cipher algorithm*/
private static String DEFAULT_ALGORITHM = "RSA";
+ /*Cipher algorithm */
private String algorithm = DEFAULT_ALGORITHM;
+ /* Cipher operation mode - encrypt or decrypt */
private String operationMode;
+ /* Mode of operation - ECB,CCB,etc*/
private String mode;
+ /* Type of the input to the cipher */
private String inType;
+ /* Type of the output from the cipher - base64*/
private String outType;
+ /* Ciphering type - asymmetric , symmetric*/
private String type;
public String getAlgorithm() {
@@ -45,7 +52,7 @@
public void setAlgorithm(String algorithm) {
if (algorithm == null || "".equals(algorithm)) {
if (log.isDebugEnabled()) {
- log.debug("Given algorithm is null, using a defaut one : RSA");
+ log.debug("Given algorithm is null, using a default one :
RSA");
}
}
this.algorithm = algorithm;
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/KeyStoreInformation.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/KeyStoreInformation.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/KeyStoreInformation.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/KeyStoreInformation.java
Tue Jul 8 23:13:12 2008
@@ -40,15 +40,20 @@
protected final Log log;
- public static final String KEYSTORE_CERTIFICATE_FILE_PATH =
"keyStoreCertificateFilePath";
+ public static final String KEY_STORE_CERTIFICATE_FILE_PATH =
"keyStoreCertificateFilePath";
public static final String ENABLE_HOST_NAME_VERIFIER =
"enableHostnameVerifier";
+ /* KeyStore type */
private KeyStoreType storeType;
+ /* Alias who belong this key */
private String alias;
+ /* KeyStore location */
private String location;
+ /* KeyStore Password to unlock KeyStore */
private String keyStorePassword;
+ /* KeyStore provider */
private String provider;
- private final Map parameters = new HashMap();
+ private final Map<String, String> parameters = new HashMap<String,
String>();
protected KeyStoreInformation() {
log = LogFactory.getLog(this.getClass());
@@ -101,7 +106,7 @@
}
public String getParameter(String name) {
- return (String) parameters.get(name);
+ return parameters.get(name);
}
/**
@@ -111,6 +116,10 @@
*/
protected KeyStore getKeyStore() {
+ if (log.isDebugEnabled()) {
+ log.debug("Loading KeyStore with type : " + storeType);
+ }
+
switch (storeType) {
case JKS:
IKeyStoreLoader jksKeyStoreLoader = new
JKSKeyStoreLoader(location,
@@ -123,7 +132,7 @@
return pkcs12KeyStoreLoader.getKeyStore();
case PKCS8:
IKeyStoreLoader pkcs8KeyStoreLoader = new
PKCS8KeyStoreLoader(location,
- (String)
parameters.get(KEYSTORE_CERTIFICATE_FILE_PATH),
+ parameters.get(KEY_STORE_CERTIFICATE_FILE_PATH),
keyStorePassword, alias);
return pkcs8KeyStoreLoader.getKeyStore();
case CA_CERTIFICATES_PATH:
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/factory/KeyStoreInformationFactory.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/factory/KeyStoreInformationFactory.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/factory/KeyStoreInformationFactory.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/definition/factory/KeyStoreInformationFactory.java
Tue Jul 8 23:13:12 2008
@@ -28,7 +28,7 @@
import java.util.Properties;
/**
- * Factory for creating KeyStoreInformation
+ * Factory for creating KeyStoreInformation based on properties
*/
public class KeyStoreInformationFactory {
@@ -75,6 +75,7 @@
}
return null;
}
+
IdentityKeyStoreInformation keyStoreInformation = new
IdentityKeyStoreInformation();
keyStoreInformation.setAlias(
MiscellaneousUtil.getProperty(properties,
@@ -91,6 +92,8 @@
properties, IDENTITY_KEY_PASSWORD, null));
String parameterString = MiscellaneousUtil.getProperty(
properties, KEY_STORE_PARAMETERS, null);
+
+ //Adds optional parameters
parseParameter(parameterString, keyStoreInformation);
return keyStoreInformation;
}
@@ -125,10 +128,18 @@
MiscellaneousUtil.getProperty(properties,
TRUST_STORE_PASSWORD, null));
String parameterString = MiscellaneousUtil.getProperty(
properties, TRUST_STORE_PARAMETERS, null);
+
+ //Adds optional parameters
parseParameter(parameterString, trustInformation);
return trustInformation;
}
+ /**
+ * Helper method to parse parameter values (String ) and add those to
KeyStoreInformation
+ *
+ * @param parameterString Parameter String
+ * @param information KeyStoreInformation
+ */
private static void parseParameter(String parameterString,
KeyStoreInformation information) {
if (parameterString == null || "".equals(parameterString)) {
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/interfaces/IKeyStoreLoader.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/interfaces/IKeyStoreLoader.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/interfaces/IKeyStoreLoader.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/interfaces/IKeyStoreLoader.java
Tue Jul 8 23:13:12 2008
@@ -3,7 +3,7 @@
import java.security.KeyStore;
/**
- * Provides way to load KeyStore
+ * Provides a way to load KeyStore
*/
public interface IKeyStoreLoader {
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/AbstractKeyStoreLoader.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/AbstractKeyStoreLoader.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/AbstractKeyStoreLoader.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/AbstractKeyStoreLoader.java
Tue Jul 8 23:13:12 2008
@@ -34,7 +34,7 @@
import java.security.cert.CertificateException;
/**
- * Provides the base for loading KeyStores
+ * Provides the base for loading KeyStores
*/
public abstract class AbstractKeyStoreLoader implements IKeyStoreLoader {
protected static Log log;
@@ -44,8 +44,9 @@
}
/**
- * Constructs a KeyStore based on keystore location , keystore password ,
keystore type and
+ * Constructs a KeyStore based on keystore location , keystore password ,
keystore type and
* provider
+ *
* @param location The location of the KeyStore
* @param storePassword Password to unlock KeyStore
* @param storeType KeyStore type
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/CACertsLoader.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/CACertsLoader.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/CACertsLoader.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/CACertsLoader.java
Tue Jul 8 23:13:12 2008
@@ -3,16 +3,19 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
-import org.apache.synapse.security.interfaces.ICACertsLoader;
import org.apache.synapse.SynapseException;
+import org.apache.synapse.security.interfaces.ICACertsLoader;
-import java.io.*;
+import java.io.BufferedInputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
import java.security.KeyStore;
-import java.security.NoSuchAlgorithmException;
import java.security.KeyStoreException;
+import java.security.NoSuchAlgorithmException;
import java.security.cert.Certificate;
-import java.security.cert.CertificateFactory;
import java.security.cert.CertificateException;
+import java.security.cert.CertificateFactory;
/**
* Constructs a keyStore from CA certificates
@@ -47,7 +50,6 @@
BufferedInputStream bis = new BufferedInputStream(inStream);
CertificateFactory certFactory =
CertificateFactory.getInstance("X509");
-
Certificate cert = certFactory.generateCertificate(bis);
trustStore.setCertificateEntry(currentCert.getName(), cert);
@@ -58,7 +60,8 @@
return trustStore;
} catch (IOException e) {
- handleException("IOError", e);
+ handleException("IOError when reading certificates from " +
+ "directory : " + CACertificateFilesPath, e);
} catch (NoSuchAlgorithmException e) {
handleException("Error creating a KeyStore", e);
} catch (KeyStoreException e) {
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/JKSKeyStoreLoader.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/JKSKeyStoreLoader.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/JKSKeyStoreLoader.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/JKSKeyStoreLoader.java
Tue Jul 8 23:13:12 2008
@@ -6,7 +6,7 @@
import java.security.KeyStore;
/**
- * Loads KeyStore from JKS file
+ * Loads KeyStore from a JKS file
*/
public class JKSKeyStoreLoader extends AbstractKeyStoreLoader {
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS12KeyStoreLoader.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS12KeyStoreLoader.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS12KeyStoreLoader.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS12KeyStoreLoader.java
Tue Jul 8 23:13:12 2008
@@ -11,7 +11,7 @@
/**
* constructs an instance of KeyStoreLoader
*
- * @param keystorePath - path to Keystore file. KeyStore must be in
pkcs12 format.
+ * @param keystorePath - path to KeyStore file. KeyStore must be in
pkcs12 format.
* @param keyStorePassword - password to access keyStore
*/
public PKCS12KeyStoreLoader(String keystorePath, String keyStorePassword) {
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS8KeyStoreLoader.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS8KeyStoreLoader.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS8KeyStoreLoader.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/keystore/PKCS8KeyStoreLoader.java
Tue Jul 8 23:13:12 2008
@@ -35,7 +35,8 @@
* PEM encoded and unencrypted.
* @param certFilePath - path to certificate file. File must be
PEM encoded.
* @param keyPass - password to secure the private key within
the keystore.
- * This will be required later to retrieve the
private key back from the keystore.
+ * This will be required later to retrieve the
private key
+ * back from the keystore.
* @param entryAlias - alias for the given entry within the
keystore.
*/
public PKCS8KeyStoreLoader(String pkcs8PrivateKeyPath, String
certFilePath, String keyPass, String entryAlias) {
@@ -74,18 +75,31 @@
FileInputStream fileInputStream = new FileInputStream(file);
BufferedInputStream bufferedInputStream = new
BufferedInputStream(fileInputStream);
+ ByteArrayOutputStream outStream = new ByteArrayOutputStream();
- byte[] keyBytes = new byte[bufferedInputStream.available()];
- bufferedInputStream.read(keyBytes);
+ byte[] buffer = new byte[1024];
+ int length;
+ try {
+ while ((length = bufferedInputStream.read(buffer)) != -1) {
+ outStream.write(buffer, 0, length);
+ }
+ } catch (IOException e) {
+ handleException("IOError reading from file : " + pkPath, e);
+ } finally {
+ try {
+ bufferedInputStream.close();
+ fileInputStream.close();
+ outStream.close();
+ } catch (IOException ignored) {
- bufferedInputStream.close();
- fileInputStream.close();
+ }
+ }
if (log.isDebugEnabled()) {
log.debug("Creating a private key in PKCS8Encoded using given"
+
" (unencrypted) RSA private key ");
}
- PrivateKey key = createPrivateKey(keyBytes);
+ PrivateKey key = createPrivateKey(outStream.toByteArray());
if (log.isDebugEnabled()) {
log.debug("Generating a X509 certificate form given
certificate file");
@@ -137,8 +151,8 @@
/**
* Takes the (unencrypted) RSA private key in pkcs8 format, and creates a
private key out of it
*
- * @param keyBytes
- * @return
+ * @param keyBytes Byte Array of the private key
+ * @return PKCS8Encoded PrivateKey
*/
private PrivateKey createPrivateKey(byte[] keyBytes) {
@@ -149,11 +163,11 @@
System.arraycopy(keyBytes, dataStart, keyContent, 0, dataLength);
- PKCS8EncodedKeySpec pkcs8SpecPriv = new PKCS8EncodedKeySpec(
+ PKCS8EncodedKeySpec pkcs8EncodedKeySpec = new PKCS8EncodedKeySpec(
new Base64().decode(keyContent));
try {
KeyFactory keyFactory = KeyFactory.getInstance("RSA");
- return keyFactory.generatePrivate(pkcs8SpecPriv);
+ return keyFactory.generatePrivate(pkcs8EncodedKeySpec);
} catch (NoSuchAlgorithmException e) {
handleException("Error getting a KeyFactory instance", e);
} catch (InvalidKeySpecException e) {
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/CipherWrapper.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/CipherWrapper.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/CipherWrapper.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/CipherWrapper.java
Tue Jul 8 23:13:12 2008
@@ -117,7 +117,7 @@
out.write(buffer, 0, length);
}
} catch (IOException e) {
- handleException("IOError !! ", e);
+ handleException("IOError when reading the input stream for cipher
", e);
} finally {
try {
inputStream.close();
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/IdentityKeyStoreWrapper.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/IdentityKeyStoreWrapper.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/IdentityKeyStoreWrapper.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/IdentityKeyStoreWrapper.java
Tue Jul 8 23:13:12 2008
@@ -96,6 +96,11 @@
return null;
}
+ /**
+ * Abstraction for getting Private Entry KeyStore(Identity)
+ *
+ * @return KeyStore Instance
+ */
public KeyStore getIdentityKeyStore() {
return getKeyStore();
}
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/KeyStoreWrapper.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/KeyStoreWrapper.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/KeyStoreWrapper.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/KeyStoreWrapper.java
Tue Jul 8 23:13:12 2008
@@ -162,6 +162,11 @@
throw new SynapseException(msg);
}
+ /**
+ * Returns KeyStore Information
+ *
+ * @return KeyStore Instance
+ */
protected KeyStore getKeyStore() {
return keyStore;
}
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/TrustKeyStoreWrapper.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/TrustKeyStoreWrapper.java?rev=675102&r1=675101&r2=675102&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/TrustKeyStoreWrapper.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/security/wrappers/TrustKeyStoreWrapper.java
Tue Jul 8 23:13:12 2008
@@ -35,6 +35,11 @@
super.init(information, null);
}
+ /**
+ * Abstraction for getting Trusted KeyStore
+ *
+ * @return KeyStore instance
+ */
public KeyStore getTrustKeyStore() {
return getKeyStore();
}
