satin.aro
Class AROincomingRequest

java.lang.Object
  |
  +--satin.aro.AROdatum
        |
        +--satin.aro.AROcompoundDatum
              |
              +--satin.aro.AROincomingRequest

public class AROincomingRequest
extends AROcompoundDatum

An incoming request. This class is for use within an ARO server. It is not of any use to ARO clients.

Author:

Ed Stauff

Fields inherited from class satin.aro.AROcompoundDatum

debug

Fields inherited from class satin.aro.AROdatum

gotten, name

Constructor Summary

AROincomingRequest(java.lang.String input)
Constructs a request from an ARO protocol string.

Method Summary

void	clear() Clears the request so the object can be reused.
void	finish() Makes sure that all the data elements have been read.
java.lang.String	getFunctionName() Returns the function (method or global subroutine) name.
java.lang.String	getRawMessage() Returns the raw ARO protocol message.
java.lang.String	getRequestID() Returns the request ID.
AROobjectID	getThisObject() Returns the ARO "this" object for the request, or null if the request is a global subroutine.
boolean	isAsynch() Returns whether the request is asynchronous.
boolean	isFinished() Tells whether finish has been called on this object.

Methods inherited from class satin.aro.AROcompoundDatum

addDatum, addToOutput, dump, exists, findByName, firstChar, getAROtypeName, getBoolean, getBoolean, getCompound, getCompound, getCompound, getCount, getDatum, getInteger, getInteger, getName, getNth, getObjectID, getObjectID, getReal, getReal, getString, getString, parseAssignment, parseDatum, parseName, removeAll, toString, trimLeadingSpaces

Methods inherited from class satin.aro.AROdatum

addToOutput, dump, getBoolean, getInteger, getName, getObjectID, getReal, getString, wasGotten

Methods inherited from class java.lang.Object

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

Constructor Detail

AROincomingRequest

public AROincomingRequest(java.lang.String input)
                   throws satin.aro.AROsyntaxError

Constructs a request from an ARO protocol string.

Parameters:

input

an ARO protocol string containing a response.

Method Detail

getFunctionName

public java.lang.String getFunctionName()

Returns the function (method or global subroutine) name.

getRequestID

public java.lang.String getRequestID()

Returns the request ID.

isAsynch

public boolean isAsynch()

Returns whether the request is asynchronous.

clear

public void clear()

Clears the request so the object can be reused.

getThisObject

public AROobjectID getThisObject()

Returns the ARO "this" object for the request, or null if the request is a global subroutine.

finish

public void finish()

Makes sure that all the data elements have been read. This is used in server-side wrapper methods to check for extraneous data in a request. Throws an exception if the request contains any data elements whose value has not been gotten at least once, as reported by the wasGotten method.

isFinished

public boolean isFinished()

Tells whether finish has been called on this object.

getRawMessage

public java.lang.String getRawMessage()

Returns the raw ARO protocol message. This is intended only for diagnostic use.

Revision History

4/6/01 Ed Stauff - changes per initial code review.

4/5/01 Ed Stauff - made changes per review.

3/27/01 Ed Stauff - initial review.