/*
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001,2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache JMeter" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* "Apache JMeter", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.jmeter.protocol.http.gui;
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.io.File;
import java.io.IOException;
import javax.swing.BorderFactory;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.ListSelectionModel;
import javax.swing.table.TableCellEditor;
import org.apache.jmeter.config.gui.AbstractConfigGui;
import org.apache.jmeter.gui.util.FileDialoger;
import org.apache.jmeter.gui.util.PowerTableModel;
import org.apache.jmeter.protocol.http.control.Cookie;
import org.apache.jmeter.protocol.http.control.CookieManager;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.testelement.property.PropertyIterator;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jorphan.gui.layout.VerticalLayout;
import org.apache.log.Hierarchy;
import org.apache.log.Logger;
/****************************************
* Allows the user to specify if she needs cookie services, and give parameters
* for this service.
*
*@author $Author: thads $
*@created $Date: 2003/06/23 20:28:43 $
*@version $Revision: 1.11 $
***************************************/
public class CookiePanel extends AbstractConfigGui implements ActionListener
{
transient private static Logger log = Hierarchy.getDefaultHierarchy().getLoggerFor(
"jmeter.protocol.http");
private static final String ADD_COMMAND = "Add";
private static final String DELETE_COMMAND = "Delete";
private static final String LOAD_COMMAND = "Load";
private static final String SAVE_COMMAND = "Save";
private JTable cookieTable;
private PowerTableModel tableModel;
private JCheckBox clearEachIteration;
private static final String clearEachIterationLabel = "clear_cookies_per_iter";
private static final String[] columnNames = {
JMeterUtils.getResString("name"),
JMeterUtils.getResString("value"),
JMeterUtils.getResString("domain"),
JMeterUtils.getResString("path"),
JMeterUtils.getResString("secure"),
JMeterUtils.getResString("expiration"),
};
private static final Class[] columnClasses = {
String.class,
String.class,
String.class,
String.class,
Boolean.class,
Long.class,
};
private JButton addButton;
private JButton deleteButton;
private JButton loadButton;
private JButton saveButton;
/****************************************
* Default constructor
***************************************/
public CookiePanel()
{
tableModel = new PowerTableModel(columnNames, columnClasses);
clearEachIteration = new JCheckBox(JMeterUtils.getResString(clearEachIterationLabel), false);
init();
}
/****************************************
* !ToDoo (Method description)
*
*@return !ToDo (Return description)
***************************************/
public String getStaticLabel()
{
return JMeterUtils.getResString("cookie_manager_title");
}
/****************************************
* Description of the Method
*
*@param e Description of Parameter
***************************************/
public void actionPerformed(ActionEvent e)
{
String action = e.getActionCommand();
if(action.equals("Delete"))
{
if(tableModel.getRowCount() > 0)
{
// If a table cell is being edited, we must cancel the editing before
// deleting the row
if(cookieTable.isEditing())
{
TableCellEditor cellEditor = cookieTable.getCellEditor(cookieTable.getEditingRow(), cookieTable.getEditingColumn());
cellEditor.cancelCellEditing();
}
int rowSelected = cookieTable.getSelectedRow();
if(rowSelected != -1)
{
tableModel.removeRow(rowSelected);
tableModel.fireTableDataChanged();
// Disable the DELETE and SAVE buttons if no rows remaining after delete
if(tableModel.getRowCount() == 0)
{
deleteButton.setEnabled(false);
saveButton.setEnabled(false);
}
// Table still contains one or more rows, so highlight (select)
// the appropriate one.
else
{
int rowToSelect = rowSelected;
if(rowSelected >= tableModel.getRowCount())
{
rowToSelect = rowSelected - 1;
}
cookieTable.setRowSelectionInterval(rowToSelect, rowToSelect);
}
}
}
}
else if(action.equals("Add"))
{
// If a table cell is being edited, we should accept the current value
// and stop the editing before adding a new row.
if(cookieTable.isEditing())
{
TableCellEditor cellEditor = cookieTable.getCellEditor(cookieTable.getEditingRow(), cookieTable.getEditingColumn());
cellEditor.stopCellEditing();
}
tableModel.addNewRow();
tableModel.fireTableDataChanged();
// Enable the DELETE and SAVE buttons if they are currently disabled.
if(!deleteButton.isEnabled())
{
deleteButton.setEnabled(true);
}
if(!saveButton.isEnabled())
{
saveButton.setEnabled(true);
}
// Highlight (select) the appropriate row.
int rowToSelect = tableModel.getRowCount() - 1;
cookieTable.setRowSelectionInterval(rowToSelect, rowToSelect);
}
else if(action.equals("Load"))
{
try
{
File tmp = FileDialoger.promptToOpenFile().getSelectedFile();
if(tmp != null)
{
CookieManager manager = new CookieManager();
manager.addFile(tmp.getAbsolutePath());
Cookie cookie = manager.get(0);
addCookieToTable(cookie);
tableModel.fireTableDataChanged();
if(tableModel.getRowCount() > 0)
{
deleteButton.setEnabled(true);
saveButton.setEnabled(true);
}
}
}
catch(IOException ex)
{
log.error("",ex);
}
catch(NullPointerException err){}
}
else if(action.equals("Save"))
{
try
{
File tmp = FileDialoger.promptToSaveFile(null).getSelectedFile();
if(tmp != null)
{
((CookieManager)createTestElement()).save(tmp.getAbsolutePath());
}
}
catch(IOException ex)
{
log.error("",ex);
}
catch(NullPointerException err){}
}
}
private void addCookieToTable(Cookie cookie) {
tableModel.addRow(new Object[]{cookie.getName(),cookie.getValue(),
cookie.getDomain(),cookie.getPath(),
new Boolean(cookie.getSecure()),
new Long(cookie.getExpires())});
}
/**
* Modifies a given TestElement to mirror the data in the gui components.
* @see org.apache.jmeter.gui.JMeterGUIComponent#modifyTestElement(TestElement)
*/
public void modifyTestElement(TestElement cm)
{
cm.clear();
configureTestElement(cm);
if(cm instanceof CookieManager)
{
CookieManager cookieManager = (CookieManager)cm;
for(int i = 0;i < tableModel.getRowCount();i++)
{
Cookie cookie = createCookie(tableModel.getRowData(i));
cookieManager.add(cookie);
}
cookieManager.setClearEachIteration(clearEachIteration.isSelected());
}
}
private Cookie createCookie(Object[] rowData)
{
Cookie cookie = new Cookie((String)rowData[0],(String)rowData[1],(String)rowData[2],
(String)rowData[3],((Boolean)rowData[4]).booleanValue(),
((Long)rowData[5]).longValue());
return cookie;
}
private void populateTable(CookieManager manager)
{
tableModel.clearData();
PropertyIterator iter = manager.getCookies().iterator();
while(iter.hasNext())
{
addCookieToTable((Cookie)iter.next().getObjectValue());
}
}
/****************************************
* !ToDo (Method description)
*
*@return !ToDo (Return description)
***************************************/
public TestElement createTestElement()
{
CookieManager cookieManager = new CookieManager();
modifyTestElement(cookieManager);
return cookieManager;
}
/****************************************
* !ToDo (Method description)
*
*@param el !ToDo (Parameter description)
***************************************/
public void configure(TestElement el)
{
super.configure(el);
populateTable((CookieManager)el);
clearEachIteration.setSelected(((CookieManager)el).getClearEachIteration());
}
/****************************************
* Shows the main cookie configuration panel
***************************************/
public void init()
{
setLayout(new BorderLayout());
setBorder(makeBorder());
JPanel northPanel = new JPanel();
northPanel.setLayout(new VerticalLayout(5, VerticalLayout.LEFT));
northPanel.add(makeTitlePanel());
northPanel.add(clearEachIteration);
add (northPanel, BorderLayout.NORTH);
add (createCookieTablePanel(), BorderLayout.CENTER);
}
/****************************************
* !ToDo (Method description)
*
*@return !ToDo (Return description)
***************************************/
public JPanel createCookieTablePanel()
{
// create the JTable that holds one cookie per row
cookieTable = new JTable(tableModel);
cookieTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
cookieTable.setPreferredScrollableViewportSize(new Dimension(100, 70));
JPanel buttonPanel = createButtonPanel();
JPanel panel = new JPanel(new BorderLayout(0, 5));
panel.setBorder(BorderFactory.createTitledBorder(BorderFactory.createEtchedBorder(), JMeterUtils.getResString("cookies_stored")));
panel.add(new JScrollPane(cookieTable), BorderLayout.CENTER);
panel.add(buttonPanel, BorderLayout.SOUTH);
return panel;
}
private JButton createButton(String resName, char mnemonic, String command, boolean enabled) {
JButton button = new JButton(JMeterUtils.getResString(resName));
button.setMnemonic(mnemonic);
button.setActionCommand(command);
button.setEnabled(enabled);
button.addActionListener(this);
return button;
}
private JPanel createButtonPanel() {
boolean tableEmpty = (tableModel.getRowCount() == 0);
addButton = createButton("add", 'A', ADD_COMMAND, true);
deleteButton = createButton("delete", 'D', DELETE_COMMAND, !tableEmpty);
loadButton = createButton("load", 'L', LOAD_COMMAND, true);
saveButton = createButton("save", 'S', SAVE_COMMAND, !tableEmpty);
JPanel buttonPanel = new JPanel();
buttonPanel.add(addButton);
buttonPanel.add(deleteButton);
buttonPanel.add(loadButton);
buttonPanel.add(saveButton);
return buttonPanel;
}
}