Package org.jdesktop.swingx.action
Class ServerAction
- java.lang.Object
-
- javax.swing.AbstractAction
-
- org.jdesktop.swingx.action.ServerAction
-
- All Implemented Interfaces:
java.awt.event.ActionListener
,java.io.Serializable
,java.lang.Cloneable
,java.util.EventListener
,javax.swing.Action
public class ServerAction extends javax.swing.AbstractAction
An action which will invoke an http POST operation.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ServerAction()
ServerAction(java.lang.String name)
ServerAction(java.lang.String name, java.lang.String command)
ServerAction(java.lang.String name, java.lang.String command, javax.swing.Icon icon)
ServerAction(java.lang.String name, javax.swing.Icon icon)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
actionPerformed(java.awt.event.ActionEvent evt)
Invokes the server operation when the action has been invoked.void
addHeader(java.lang.String name, java.lang.String value)
Adds a name value pair which represents a url connection request property.void
addParam(java.lang.String name, java.lang.String value)
Adds a name value pair which represents a url parameter in an http POST request.private java.lang.String
createMessage(int code, java.lang.String msg)
Creates a human readable message from the server code and message result.java.util.Set<java.lang.String>
getHeaderNames()
Return a set of parameter names or null if there are no paramsprivate java.util.Map<java.lang.String,java.lang.String>
getHeaders()
java.lang.String
getHeaderValue(java.lang.String name)
Return a header value corresponding to name or null if it doesn't exist.java.util.Set<java.lang.String>
getParamNames()
Return a set of parameter names or null if there are no paramsprivate java.util.Map<java.lang.String,java.lang.String>
getParams()
java.lang.String
getParamValue(java.lang.String name)
Return a parameter value corresponding to name or null if it doesn't exist.private java.lang.String
getPostData()
Retrieves a string which represents the parameter data for a server action.java.lang.String
getURL()
private void
setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
private void
setParams(java.util.Map<java.lang.String,java.lang.String> params)
void
setURL(java.lang.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
-
-
-
-
Field Detail
-
LOG
private static final java.util.logging.Logger LOG
-
PARAMS
private static final java.lang.String PARAMS
- See Also:
- Constant Field Values
-
HEADERS
private static final java.lang.String HEADERS
- See Also:
- Constant Field Values
-
URL
private static final java.lang.String URL
- See Also:
- Constant Field Values
-
URL_CACHE
private static final java.lang.String URL_CACHE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ServerAction
public ServerAction()
-
ServerAction
public ServerAction(java.lang.String name)
-
ServerAction
public ServerAction(java.lang.String name, java.lang.String command)
- Parameters:
name
- display name of the actioncommand
- the value of the action command key
-
ServerAction
public ServerAction(java.lang.String name, javax.swing.Icon icon)
-
ServerAction
public ServerAction(java.lang.String name, java.lang.String command, javax.swing.Icon icon)
- Parameters:
name
- display name of the actioncommand
- the value of the action command keyicon
- icon to display
-
-
Method Detail
-
setURL
public void setURL(java.lang.String url)
Set the url for the action.- Parameters:
url
- a string representation of the url
-
getURL
public java.lang.String getURL()
-
getParams
private java.util.Map<java.lang.String,java.lang.String> getParams()
-
setParams
private void setParams(java.util.Map<java.lang.String,java.lang.String> params)
-
addParam
public void addParam(java.lang.String name, java.lang.String value)
Adds a name value pair which represents a url parameter in an http POST request.
-
getParamValue
public java.lang.String getParamValue(java.lang.String name)
Return a parameter value corresponding to name or null if it doesn't exist.
-
getParamNames
public java.util.Set<java.lang.String> getParamNames()
Return a set of parameter names or null if there are no params
-
getHeaders
private java.util.Map<java.lang.String,java.lang.String> getHeaders()
-
setHeaders
private void setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
-
addHeader
public void addHeader(java.lang.String name, java.lang.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 java.lang.String getHeaderValue(java.lang.String name)
Return a header value corresponding to name or null if it doesn't exist.
-
getHeaderNames
public java.util.Set<java.lang.String> getHeaderNames()
Return a set of parameter names or null if there are no params
-
actionPerformed
public void actionPerformed(java.awt.event.ActionEvent evt)
Invokes the server operation when the action has been invoked.
-
getPostData
private java.lang.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 '&'
-
createMessage
private java.lang.String createMessage(int code, java.lang.String msg)
Creates a human readable message from the server code and message result.- Parameters:
code
- an http error code.msg
- server message
-
-