POP3/IMAP Sampler with TLS/SSL #1669
Labels
Comments
|
Ralf Hauser (migrated from Bugzilla): |
|
Marco Vergari (migrated from Bugzilla): Let me know what you think about my increments. I would be happy if this |
|
Marco Vergari (migrated from Bugzilla): MailReaderSampler.java/*
* Copyright 2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.jmeter.protocol.mail.sampler;
import java.util.Properties;
import javax.mail.*;
import javax.mail.internet.MimeMultipart;
import org.apache.jmeter.samplers.AbstractSampler;
import org.apache.jmeter.samplers.Entry;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.testelement.property.BooleanProperty;
import org.apache.jmeter.testelement.property.IntegerProperty;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;
/**
* @author Thad Smith, Marco Vergari
*/
public class MailReaderSampler extends AbstractSampler {
private static Logger log = LoggingManager.getLoggerForClass();
// Where we keep all of the mail connection information
// NOTUSED private Properties props = new Properties();
// Static data identifiers
private final static String SERVER_TYPE = "host_type";
private final static String SERVER = "host";
private final static String PORT = "port";
private final static String SECURE = "secure";
private final static String USERNAME = "username";
private final static String PASSWORD = "password";
private final static String FOLDER = "folder";
private final static String DELETE = "delete";
private final static String NUM_MESSAGES = "num_messages";
// Static data values
public final static String TYPE_POP3 = "pop3";
public final static String TYPE_IMAP = "imap";
private final static String SSL_FACTORY = "org.apache.jmeter.protocol.mail.sampler.DummySSLSocketFactory";
private final static String MAIL_DEL = "\n===========================================================================\n";
public MailReaderSampler() {
setServerType(TYPE_POP3);
setFolder("INBOX");
setNumMessages(-1);
setDeleteMessages(false);
}
/*
* (non-Javadoc) Performs the sample, and returns the result
*
* @see org.apache.jmeter.samplers.Sampler#sample(org.apache.jmeter.samplers.Entry)
*/
public SampleResult sample(Entry e) {
SampleResult res = new SampleResult();
boolean isOK = false; // Did sample succeed?
/*
* Perform the sampling
*/
res.setSampleLabel(getName());
res.setContentType("text/plain");
res.setSamplerData(getServerType() + "://" + getUserName() + "@" + getServer() + ":" + Integer.toString(getServerPort()));
res.setDataType(SampleResult.TEXT);
res.sampleStart(); // Start timing
try {
// Set properties
Properties props = System.getProperties();
if(isSecure()) {
props.setProperty("mail.pop3.socketFactory.class", SSL_FACTORY);
}
props.setProperty("mail.pop3.socketFactory.fallback", "false");
props.setProperty("mail.pop3.port", Integer.toString(getServerPort()));
props.setProperty("mail.pop3.socketFactory.port", Integer.toString(getServerPort()));
// Get session
Session session = Session.getInstance(props, null);
// Get the store
Store store = session.getStore(getServerType());
store.connect(getServer(), getUserName(), getPassword());
// Get folder
Folder folder = store.getFolder(getFolder());
folder.open(Folder.READ_WRITE);
// Get directory
Message messages[] = folder.getMessages();
Message message;
StringBuffer data = new StringBuffer();
data.append(messages.length + " new messages");
data.append(MAIL_DEL);
int n = getNumMessages();
if((n == -1) || (n > messages.length)) {
n = messages.length;
}
for(int i=0; i<n; i++) {
message = messages[i];
data.append("Message " + message.getMessageNumber() + ":\n");
data.append("Date: " + message.getSentDate() + "\n");
data.append("To: ");
Address[] recips = message.getAllRecipients();
for(int j=0; j<recips.length; j++) {
data.append(recips[j].toString());
if(j < (recips.length - 1)) {
data.append("; ");
}
}
data.append("\n");
data.append("From: ");
Address[] from = message.getFrom();
for(int j=0; j<from.length; j++) {
data.append(from[j].toString());
if (j < (from.length - 1)) {
data.append("; ");
}
}
data.append("\n");
data.append("Subject: " + message.getSubject() + "\n");
if(message.getContentType().startsWith("multi")) {
Multipart mp = (Multipart)message.getContent();
for(int j=0; j<mp.getCount(); j++) {
data.append("\nContent-Type: " + mp.getBodyPart(j).getContentType());
data.append("\nDescription: " + mp.getBodyPart(j).getDescription());
data.append("\nDisposition: " + mp.getBodyPart(j).getDisposition());
data.append("\nFilename: " + mp.getBodyPart(j).getFileName());
data.append("\nLinecount: " + mp.getBodyPart(j).getLineCount());
data.append("\nSize: " + mp.getBodyPart(j).getSize());
}
} else {
data.append("\n" + message.getContent());
}
data.append(MAIL_DEL);
if(getDeleteMessages()) {
message.setFlag(Flags.Flag.DELETED, true);
}
}
// Close connection
folder.close(true);
store.close();
/*
* Set up the sample result details
*/
res.setResponseData(data.toString().getBytes());
res.setResponseCode("200");
res.setResponseMessage("OK");
isOK = true;
} catch(Exception ex) {
log.error("Error occured during reading mails...", ex);
res.setResponseData(ex.toString().getBytes());
res.setResponseCode("500");
res.setResponseMessage("Server-Error");
}
res.sampleEnd();
res.setSuccessful(isOK);
return res;
}
/**
* Sets the type of protocol to use when talking with the remote mail
* server. Either MailReaderSampler.TYPE_IMAP or
* MailReaderSampler.TYPE_POP3. Default is MailReaderSampler.TYPE_POP3.
*
* @param serverType
*/
public void setServerType(String serverType) {
setProperty(SERVER_TYPE, serverType);
}
/**
* Returns the type of the protocol set to use when talking with the remote
* server. Either MailReaderSampler.TYPE_IMAP or
* MailReaderSampler.TYPE_POP3.
*
* @return Server Type
*/
public String getServerType() {
return getProperty(SERVER_TYPE).toString();
}
/**
* @param port - the server port of the remote server.
*/
public void setServerPort(int port) {
setProperty(new IntegerProperty(PORT, port));
}
/**
* @return the server port of the remote server.
*/
public int getServerPort() {
return getPropertyAsInt(PORT);
}
/**
* @param secure - use SSL/TLS for the request.
*/
public void setSecure(boolean secure) {
setProperty(new BooleanProperty(SECURE, secure));
}
/**
* @return use SSL/TLS for the request.
*/
public boolean isSecure() {
return getPropertyAsBoolean(SECURE);
}
/**
* @param server -
* The name or address of the remote server.
*/
public void setServer(String server) {
setProperty(SERVER, server);
}
/**
* @return The name or address of the remote server.
*/
public String getServer() {
return getProperty(SERVER).toString();
}
/**
* @param username -
* The username of the mail account.
*/
public void setUserName(String username) {
setProperty(USERNAME, username);
}
/**
* @return The username of the mail account.
*/
public String getUserName() {
return getProperty(USERNAME).toString();
}
/**
* @param password
*/
public void setPassword(String password) {
setProperty(PASSWORD, password);
}
/**
* @return password
*/
public String getPassword() {
return getProperty(PASSWORD).toString();
}
/**
* @param folder -
* Name of the folder to read emails from. "INBOX" is the only
* acceptable value if the server type is POP3.
*/
public void setFolder(String folder) {
setProperty(FOLDER, folder);
}
/**
* @return folder
*/
public String getFolder() {
return getProperty(FOLDER).toString();
}
/**
* @param num_messages -
* The number of messages to retrieve from the mail server. Set
* this value to -1 to retrieve all messages.
*/
public void setNumMessages(int num_messages) {
setProperty(new IntegerProperty(NUM_MESSAGES, num_messages));
}
/**
* @return The number of messages to retrive from the mail server. -1
* denotes get all messages.
*/
public int getNumMessages() {
return getPropertyAsInt(NUM_MESSAGES);
}
/**
* @param delete -
* Whether or not to delete the read messages from the folder.
*/
public void setDeleteMessages(boolean delete) {
setProperty(new BooleanProperty(DELETE, delete));
}
/**
* @return Whether or not to delete the read messages from the folder.
*/
public boolean getDeleteMessages() {
return getPropertyAsBoolean(DELETE);
}
} |
|
Marco Vergari (migrated from Bugzilla): |
|
Marco Vergari (migrated from Bugzilla): |
|
Marco Vergari (migrated from Bugzilla): DummySSLSocketFactory.java/*
* Copyright 2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.jmeter.protocol.mail.sampler;
import java.io.IOException;
import java.net.InetAddress;
import java.net.Socket;
import javax.net.SocketFactory;
import javax.net.ssl.*;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;
/**
* @author Marco Vergari
*/
public class DummySSLSocketFactory extends SSLSocketFactory {
private static Logger log = LoggingManager.getLoggerForClass();
private SSLSocketFactory factory;
public DummySSLSocketFactory() {
try {
SSLContext sslcontext = SSLContext.getInstance("TLS");
sslcontext.init(null, new TrustManager[] {new DummyTrustManager()}, new java.security.SecureRandom());
factory = sslcontext.getSocketFactory();
} catch(Exception e) {
log.error("Error occurred during initialize sslcontext...", e);
}
}
public static SocketFactory getDefault() {
return new DummySSLSocketFactory();
}
public Socket createSocket(Socket socket, String host, int port, boolean autoClose) throws IOException {
return factory.createSocket(socket, host, port, autoClose);
}
public Socket createSocket(InetAddress addr, int port, InetAddress localAddr, int localPort) throws IOException {
return factory.createSocket(addr, port, localAddr, localPort);
}
public Socket createSocket(InetAddress host, int port) throws IOException {
return factory.createSocket(host, port);
}
public Socket createSocket(String host, int port, InetAddress localHost, int localPort) throws IOException {
return factory.createSocket(host, port, localHost, localPort);
}
public Socket createSocket(String host, int port) throws IOException {
return factory.createSocket(host, port);
}
public String[] getDefaultCipherSuites() {
return factory.getSupportedCipherSuites();
}
public String[] getSupportedCipherSuites() {
return factory.getSupportedCipherSuites();
}
}````
</details> |
|
Marco Vergari (migrated from Bugzilla): DummyTrustManager.java/*
* Copyright 2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.jmeter.protocol.mail.sampler;
import java.security.cert.*;
import javax.net.ssl.X509TrustManager;
/**
* @author Marco Vergari
*/
public class DummyTrustManager implements X509TrustManager {
public X509Certificate[] getAcceptedIssuers() {
return new X509Certificate[0];
}
public void checkClientTrusted(X509Certificate[] arg0, String arg1) throws CertificateException {}
public void checkServerTrusted(X509Certificate[] arg0, String arg1) throws CertificateException {}
} |
|
Ralf Hauser (migrated from Bugzilla): |
|
Ralf Hauser (migrated from Bugzilla): |
|
Sebb (migrated from Bugzilla): |
|
Sebb (migrated from Bugzilla): So I think this request is now complete. Please re-open if not. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Marco Vergari (Bug 38384):
Is it planned to provide the POP3(SSL/TLS) and SMTP(SSL/TLS) protocol in future
releases? Has anybody make a load test to a POP3-Server(SSL/TLS) with JMeter?
How can I do that?
OS: All
The text was updated successfully, but these errors were encountered: