Package org.jdesktop.swingx.action

Class ServerAction

java.lang.Object

javax.swing.AbstractAction

org.jdesktop.swingx.action.ServerAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public class ServerAction
extends AbstractAction

An action which will invoke an http POST operation.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	HEADERS
private static final Logger	LOG
private static final String	PARAMS
private static final String	URL
private static final String	URL_CACHE

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor	Description
ServerAction()
ServerAction(String name)
ServerAction(String name, String command)
ServerAction(String name, String command, Icon icon)
ServerAction(String name, Icon icon)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent evt)	Invokes the server operation when the action has been invoked.
void	addHeader(String name, String value)	Adds a name value pair which represents a url connection request property.
void	addParam(String name, String value)	Adds a name value pair which represents a url parameter in an http POST request.
private String	createMessage(int code, String msg)	Creates a human readable message from the server code and message result.
Set<String>	getHeaderNames()	Return a set of parameter names or null if there are no params
private Map<String,String>	getHeaders()
String	getHeaderValue(String name)	Return a header value corresponding to name or null if it doesn't exist.
Set<String>	getParamNames()	Return a set of parameter names or null if there are no params
private Map<String,String>	getParams()
String	getParamValue(String name)	Return a parameter value corresponding to name or null if it doesn't exist.
private String	getPostData()	Retrieves a string which represents the parameter data for a server action.
String	getURL()
private void	setHeaders(Map<String,String> headers)
private void	setParams(Map<String,String> params)
void	setURL(String url)	Set the url for the action.

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.Action

accept

Field Details

LOG

private static final Logger LOG

PARAMS

private static final String PARAMS

See Also:

• Constant Field Values

HEADERS

private static final String HEADERS

See Also:

• Constant Field Values

URL

private static final String URL

See Also:

• Constant Field Values

URL_CACHE

private static final String URL_CACHE

See Also:

• Constant Field Values

Constructor Details

ServerAction

public ServerAction()

ServerAction

public ServerAction(String name)

ServerAction

public ServerAction(String name,
 String command)

Parameters:

name - display name of the action

command - the value of the action command key

ServerAction

public ServerAction(String name,
 Icon icon)

ServerAction

public ServerAction(String name,
 String command,
 Icon icon)

Parameters:

name - display name of the action

command - the value of the action command key

icon - icon to display

Method Details

setURL

public void setURL(String url)

Set the url for the action.

Parameters:

url - a string representation of the url

getURL

public String getURL()

getParams

private Map<String,String> getParams()

setParams

private void setParams(Map<String,String> params)

addParam

public void addParam(String name,
 String value)

Adds a name value pair which represents a url parameter in an http POST request.

getParamValue

public String getParamValue(String name)

Return a parameter value corresponding to name or null if it doesn't exist.

getParamNames

public Set<String> getParamNames()

Return a set of parameter names or null if there are no params

getHeaders

private Map<String,String> getHeaders()

setHeaders

private void setHeaders(Map<String,String> headers)

addHeader

public void addHeader(String name,
 String value)

Adds a name value pair which represents a url connection request property. For example, name could be "Content-Type" and the value could be "application/x-www-form-urlencoded"

getHeaderValue

public String getHeaderValue(String name)

Return a header value corresponding to name or null if it doesn't exist.

getHeaderNames

public Set<String> getHeaderNames()

Return a set of parameter names or null if there are no params

actionPerformed

public void actionPerformed(ActionEvent evt)

Invokes the server operation when the action has been invoked.

getPostData

private String getPostData()

Retrieves a string which represents the parameter data for a server action.

Returns:

a string of name value pairs prefixed by a '?' and delimited by an 'invalid input: '&''

createMessage

private String createMessage(int code,
 String msg)

Creates a human readable message from the server code and message result.

Parameters:

code - an http error code.

msg - server message