se.entra.phantom.rapp

Class RAPPCallClass

java.lang.Object

se.entra.phantom.rapp.RAPPAction

se.entra.phantom.rapp.RAPPCallClass

public class RAPPCallClass
extends RAPPAction

The callClass action is a user-defined action that is called in the server. The action has generic requestData and replyData parameters that allows the calling class to pass a hierarchy or Elements and Nodes to the class being called in the server. This class can then set the replyData, also as Elements or Nodes. The calling RAPP application can then extract the Elements and Nodes as required.

Example code for the calling remote application:

  RAPPTransaction trans=new RAPPTransaction();

  Element e=trans.createElement("myOwnData");
  e.setAttribute("myAttr","myValue");
  Element e2=trans.createElement("nestedData");
  e2.setAttribute("nestAttr","nestValue");
  e.appendChild(e2);

  RAPPCallClass cc=new RAPPCallClass("com.mycompany.RAPPTest",e);

  trans.addAction(cc);

  ... Send the transaction and get the reply...

  Element reply=cc.getReply();
  ... Look up relevant data ...
 

Field Summary

Fields inherited from class se.entra.phantom.rapp.RAPPAction

ACTION_CALL_CLASS, ACTION_CALL_HOST, ACTION_CALL_OBJECT, ACTION_CALL_PANEL, ACTION_GLOB_VAR, ERROR_CALL_CLASS_RUN_ACTION, ERROR_CONTROL_ID_NOT_FOUND, ERROR_GLOB_VAR_NOT_FOUND, ERROR_HOST_FIELD_NOT_FOUND, ERROR_HOST_SESSION_NOT_CONNECTED, ERROR_INSTANCIATING_CALLED_CLASS, ERROR_INTERFACE_NOT_FOUND, ERROR_NOT_CURRENT_HOST_SCREEN, ERROR_OBJECT_NOT_FOUND, ERROR_UNEXPECTED_RETURN_STRING, errorCode, errorDescription

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RAPPCallClass() Creates an empty Call Class action used for serializing data with XML documents.
	RAPPCallClass(String className) Creates the Call Class action without request data.
	RAPPCallClass(String className, Element requestData) Creates the Call Class action with the specified request data.

Method Summary

Modifier and Type	Method and Description
String	getActionClass() Returns the action class "callClass".
int	getActionType() Gets the type of action for this class.
String	getClassName() Gets the class name to call, null if not yet set.
String	getComment() Comment for action class tag when serialized from a request the first time.
RAPPNameSpaceItem	getNameSpaceItem() Gets the namespace item for this action.
Element	getReply() Gets the Element of data for the reply, null if not yet set.
Element	getRequest() Gets the Element of data for the request, null if not yet set.
String	paramString() Gets the parameter string for this class for testing purposes.
void	serializeFromReply(RAPPElement reply) Initializes the action class instance from a reply element.
void	serializeFromRequest(RAPPElement request) Initializes the action class instance from a request Element.
void	serializeToReply(RAPPElement reply) Initializes the reply Element with all attributes.
void	serializeToRequest(RAPPElement request) Initializes the request Element with all attributes.
void	setReplyData(Element replyData) Sets the Element of data for the reply.

Methods inherited from class se.entra.phantom.rapp.RAPPAction

appendReplyElement, appendReplyElement, appendRequestElement, getClass, getErrorCode, getErrorDescription, initialize, removeAllElements, setError, toString, updateReplyFromDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

RAPPCallClass

protected RAPPCallClass()

Creates an empty Call Class action used for serializing data with XML documents.

RAPPCallClass

public RAPPCallClass(String className)

Creates the Call Class action without request data.

RAPPCallClass

public RAPPCallClass(String className,
                     Element requestData)

Creates the Call Class action with the specified request data. The Element in requestData is created prior to this call using the createElement(name) in RAPPTransaction.

See Also:

RAPPTransaction.createElement(java.lang.String)

Method Detail

getNameSpaceItem

public RAPPNameSpaceItem getNameSpaceItem()

Gets the namespace item for this action.

Specified by:

getNameSpaceItem in class RAPPAction

getClassName

public String getClassName()

Gets the class name to call, null if not yet set.

getRequest

public Element getRequest()

Gets the Element of data for the request, null if not yet set.

getReply

public Element getReply()

Gets the Element of data for the reply, null if not yet set.

getActionType

public int getActionType()

Gets the type of action for this class. It is used to quickly determine an integer value from a class extending from RAPPAction.

Specified by:

getActionType in class RAPPAction

Returns:

int, ACTION_CALL_CLASS.

getActionClass

public String getActionClass()

Returns the action class "callClass".

Specified by:

getActionClass in class RAPPAction

Returns:

String the name of the action class, see above.

setReplyData

public void setReplyData(Element replyData)

Sets the Element of data for the reply. This method should be used on the server side. The data will be sent back to the client upon request and can then be fetched using getReplyData.

getComment

public String getComment()

Comment for action class tag when serialized from a request the first time.

Specified by:

getComment in class RAPPAction

serializeToRequest

public void serializeToRequest(RAPPElement request)

Initializes the request Element with all attributes.

The XML for the node looks like (replace parenthesis with less-more-than signs):

  (callClassRequest
    className="com.company.MyClass")
  [ (requestData)
      (customTag [attr="optional"])
        ### custom data inside Element ###
      (/customTag)
    (/requestData) ]
  (/callClassRequest)
 

Specified by:

serializeToRequest in class RAPPAction

serializeFromRequest

public void serializeFromRequest(RAPPElement request)
                          throws SAXException

Initializes the action class instance from a request Element.

Specified by:

serializeFromRequest in class RAPPAction

Throws:

SAXException - for errors in the document.

serializeToReply

public void serializeToReply(RAPPElement reply)

Initializes the reply Element with all attributes.

The XML for the node looks like (replace parenthesis with less-more-than signs):

  (callClassReply)
  [ (replyData)
      (customTag [attr="optional"])
        ### custom data inside Element ###
      (/customTag)
    (/replyData) ]
  (/callClassReply)
 

Specified by:

serializeToReply in class RAPPAction

serializeFromReply

public void serializeFromReply(RAPPElement reply)
                        throws SAXException

Initializes the action class instance from a reply element.

Specified by:

serializeFromReply in class RAPPAction

Throws:

SAXException - for errors in the document.

paramString

public String paramString()

Gets the parameter string for this class for testing purposes.

Overrides:

paramString in class RAPPAction