com.actuate.activeportal.forms
Class PingActionForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by com.actuate.activeportal.forms.BaseActionForm
          extended by com.actuate.activeportal.forms.PingActionForm
All Implemented Interfaces:
java.io.Serializable

public class PingActionForm
extends BaseActionForm

The form contains the variables used by ping action. Ping is a self-diagnostic utility for user to to detect status of Active Portal/iServer.

See Also:
Serialized Form

Constructor Summary
PingActionForm()
           
 
Method Summary
 void clear()
          Initialize form properties.
 java.lang.String getAction()
          Get Ping action.
 java.lang.String getConnectionProperties()
          Get connection properties.
 java.lang.String getDestination()
          Get ping destination.
 java.lang.String getFileName()
          Get file name for ReadFile action.
 java.lang.String getMode()
          Get Ping mode.
 long getNumBytes()
          Get number of bytes for WriteFile action.
 java.lang.String getPartitionName()
          Get partition name for WriteFile action.
 java.lang.String getPayload()
          Get payload for echo action.
 java.lang.String getProcessId()
          Get Ping process id.
 java.lang.String getServer()
          Get Ping server name.
 java.lang.String getServerURL()
          Get Ping server URL.
 void setAction(java.lang.String string)
          Get Ping action.
 void setConnectionProperties(java.lang.String string)
          Set connection properties for Connect action.
 void setDestination(java.lang.String string)
          Set Ping destination.
 void setFileName(java.lang.String string)
          Set file name for ReadFile action.
 void setMode(java.lang.String string)
          Set Ping mode.
 void setNumBytes(long string)
          Set number of bytes for WriteFile action.
 void setPartitionName(java.lang.String string)
          Set partition name for WriteFile action.
 void setPayload(java.lang.String string)
          Set payload for echo action.
 void setProcessId(java.lang.String string)
          Set Ping process id.
 void setServer(java.lang.String string)
          Set Ping server.
 void setServerURL(java.lang.String string)
          Set Ping server URL.
 
Methods inherited from class com.actuate.activeportal.forms.BaseActionForm
fixUTF8, isPostback, setPostback
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PingActionForm

public PingActionForm()
Method Detail

clear

public void clear()
Initialize form properties.


getAction

public java.lang.String getAction()
Get Ping action.

Returns:
the action.

getConnectionProperties

public java.lang.String getConnectionProperties()
Get connection properties.

Returns:
the connection properties.

getDestination

public java.lang.String getDestination()
Get ping destination.

Returns:
the destination.

getFileName

public java.lang.String getFileName()
Get file name for ReadFile action.

Returns:
the file name.

getMode

public java.lang.String getMode()
Get Ping mode.

Returns:
the mode.

getPartitionName

public java.lang.String getPartitionName()
Get partition name for WriteFile action.

Returns:
the partition name.

getPayload

public java.lang.String getPayload()
Get payload for echo action.

Returns:
the payload.

getProcessId

public java.lang.String getProcessId()
Get Ping process id.

Returns:
the process id.

getServer

public java.lang.String getServer()
Get Ping server name.

Returns:
the server name.

getServerURL

public java.lang.String getServerURL()
Get Ping server URL.

Returns:
the server url.

setAction

public void setAction(java.lang.String string)
Get Ping action. Action could be Echo, ReadFile, WriteFile, and Connect. Default value is Echo.

Parameters:
string -

setConnectionProperties

public void setConnectionProperties(java.lang.String string)
Set connection properties for Connect action.

Parameters:
string -

setDestination

public void setDestination(java.lang.String string)
Set Ping destination. Destination could be: AP, MDS, EE, VS, FS, and OSD. Default value is AP.

Parameters:
string -

setFileName

public void setFileName(java.lang.String string)
Set file name for ReadFile action. File name refers to a file/folder in EE.

Parameters:
string -

setMode

public void setMode(java.lang.String string)
Set Ping mode. Mode could be Concise, Normal, and Trace. Default value is Normal.

Parameters:
string -

setPartitionName

public void setPartitionName(java.lang.String string)
Set partition name for WriteFile action.

Parameters:
string -

setPayload

public void setPayload(java.lang.String string)
Set payload for echo action. Payload only avaliable for Echo action. It could be empty and its maxmium length is 102400 bytes.

Parameters:
string -

setProcessId

public void setProcessId(java.lang.String string)
Set Ping process id.

Parameters:
string -

setServer

public void setServer(java.lang.String string)
Set Ping server. IP address/machine name is acceptable.

Parameters:
string -

setServerURL

public void setServerURL(java.lang.String string)
Set Ping server URL.

Parameters:
string -

getNumBytes

public long getNumBytes()
Get number of bytes for WriteFile action.

Returns:
the number of bytes.

setNumBytes

public void setNumBytes(long string)
Set number of bytes for WriteFile action.

Parameters:
string -