|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bea.jolt.JoltRequest bea.jolt.JoltRemoteService
JoltRemoteService provides an implementation of the Tuxedo synchronous Request/Reply communication model. Jolt treats each Tuxedo service as a remote service, and each service has its input and output parameters. Typically, the user sets the input parameters through the various setXXX and addXXX methods, then invokes the call() method. Upon successful completion, the user retreives the results through the various getXXX methods. Since Queue is not supported in release 1.0, this class is extended from JoltRequest and implements RemoteService/Message to reduce the class file size. When Queue is supported in a later release, this class and RemoteQueue will be extended from JoltRequestMessage to share the single implementation of Message.
JoltSession
,
JoltTransaction
Field Summary |
Fields inherited from class bea.jolt.JoltRequest |
QUEUE, SERVICE |
Constructor Summary | |
JoltRemoteService(java.lang.String name,
Session s)
This constructor gets the service that matches the definition in the repository. |
|
JoltRemoteService(java.lang.String name,
Session s,
int version)
This constructor ensures that the version between a client program and the data in the repository match. |
Method Summary | |
void |
addByte(java.lang.String name,
byte val)
Add a byte value occurrence of an item referred by its name. |
void |
addBytes(java.lang.String name,
byte[] val,
int len)
Add a byte-array value occurrence of an item referred by its name. |
void |
addDouble(java.lang.String name,
double val)
Add a double value occurrence of an item referred by its name. |
void |
addFloat(java.lang.String name,
float val)
Add a float value occurrence of an item referred by its name. |
void |
addInt(java.lang.String name,
int val)
Add a int value occurrence of an item referred by its name. |
void |
addMBString(java.lang.String name,
java.lang.String val)
Add a mbstring value occurrence of an item referred by its name. |
void |
addShort(java.lang.String name,
short val)
Add a short value occurrence of an item referred by its name. |
void |
addString(java.lang.String name,
java.lang.String val)
Add a string value occurrence of an item referred by its name. |
void |
call(bea.jolt.Transaction trans)
Perform the synchronized request/reply. |
void |
call(bea.jolt.Transaction trans,
java.lang.String principal,
java.lang.String realm)
|
void |
clear()
Clear the input and output attributes, and the priority. |
void |
delete(java.lang.String name)
Delete the first instance of an item referred by its name. |
void |
deleteItem(java.lang.String name,
int itemNo)
Delete a particular occurrence of an item referred by its name. |
void |
done()
Done with this service object and perform some clean up. |
int |
getApplicationCode()
Get the return code from the application; it is equivalent to the tpurcode or the second parameter of tpreturn(3) from ATMI. |
byte |
getByteDef(java.lang.String name,
byte def)
Get the byte value of the first occurrence of the item. |
byte |
getByteItemDef(java.lang.String name,
int itemNo,
byte def)
Get the byte value of an occurrence of the item. |
byte[] |
getBytesDef(java.lang.String name,
byte[] def)
Get the byte-array value of the first occurrence of the item. |
byte[] |
getBytesItemDef(java.lang.String name,
int itemNo,
byte[] def)
Get the byte-array value of an occurrence of the item. |
JoltDefinition |
getDefinition()
Get the reference to the service definition. |
double |
getDoubleDef(java.lang.String name,
double def)
Get the double value of the first occurrence of the item. |
double |
getDoubleItemDef(java.lang.String name,
int itemNo,
double def)
Get the double value of an occurrence of the item. |
float |
getFloatDef(java.lang.String name,
float def)
Get the float value of the first occurrence of the item. |
float |
getFloatItemDef(java.lang.String name,
int itemNo,
float def)
Get the float value of an occurrence of the item. |
JoltMessage |
getInputs()
Get the input parameter message buffer. |
int |
getIntDef(java.lang.String name,
int def)
Get the int value of the first occurrence of the item. |
int |
getIntItemDef(java.lang.String name,
int itemNo,
int def)
Get the int value of an occurrence of the item. |
java.lang.String |
getMBStringDef(java.lang.String name,
java.lang.String def)
Get the mbstring value of the first occurrence of the item. |
java.lang.String |
getMBStringItemDef(java.lang.String name,
int itemNo,
java.lang.String def)
Get the mbstring value of an occurrence of the item. |
java.lang.String |
getName()
Get the name of this service. |
int |
getOccurrenceCount(java.lang.String name)
Get the occurrence count of an item referred by its name. |
JoltMessage |
getOutputs()
Get the output parameter message buffer. |
int |
getRequestType()
Get the type of this request object. |
short |
getShortDef(java.lang.String name,
short def)
Get the short value of the first occurrence of the item. |
short |
getShortItemDef(java.lang.String name,
int itemNo,
short def)
Get the short value of an occurrence of the item. |
java.lang.String |
getStringDef(java.lang.String name,
java.lang.String def)
Get the string value of the first occurrence of the item. |
java.lang.String |
getStringItemDef(java.lang.String name,
int itemNo,
java.lang.String def)
Get the string value of an occurrence of the item. |
void |
setByte(java.lang.String name,
byte val)
Set or change the byte value of the first occurrence of an item referred by its name. |
void |
setByteItem(java.lang.String name,
int itemNo,
byte val)
Set or change the byte value of a particular item referred by its name. |
void |
setBytes(java.lang.String name,
byte[] val,
int len)
Set or change the byte-array value of the first occurrence of an item referred by its name. |
void |
setBytesItem(java.lang.String name,
int itemNo,
byte[] val,
int len)
Set or change the byte-array value of a particular item referred by its name. |
void |
setDouble(java.lang.String name,
double val)
Set or change the double value of the first occurrence of an item referred by its name. |
void |
setDoubleItem(java.lang.String name,
int itemNo,
double val)
Set or change the double value of a particular item referred by its name. |
void |
setFloat(java.lang.String name,
float val)
Set or change the float value of the first occurrence of an item referred by its name. |
void |
setFloatItem(java.lang.String name,
int itemNo,
float val)
Set or change the float value of a particular item referred by its name. |
void |
setInt(java.lang.String name,
int val)
Set or change the int value of the first occurrence of an item referred by its name. |
void |
setIntItem(java.lang.String name,
int itemNo,
int val)
Set or change the int value of a particular item referred by its name. |
void |
setMBString(java.lang.String name,
java.lang.String val)
Set or change the mbstring value of the first occurrence of an item referred by its name. |
void |
setMBStringItem(java.lang.String name,
int itemNo,
java.lang.String val)
Set or change the mbstring value of a particular item referred by its name. |
void |
setShort(java.lang.String name,
short val)
Set or change the short value of the first occurrence of an item referred by its name. |
void |
setShortItem(java.lang.String name,
int itemNo,
short val)
Set or change the short value of a particular item referred by its name. |
void |
setString(java.lang.String name,
java.lang.String val)
Set or change the string value of the first occurrence of an item referred by its name. |
void |
setStringItem(java.lang.String name,
int itemNo,
java.lang.String val)
Set or change the string value of a particular item referred by its name. |
java.lang.String |
toString()
Get the service name of this object. |
Methods inherited from class bea.jolt.JoltRequest |
setNoTimeOut, setRequestPriority |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public JoltRemoteService(java.lang.String name, Session s) throws ServiceException
name
- The service names
- The session object
ServiceException
- Invalid session or no such service.public JoltRemoteService(java.lang.String name, Session s, int version) throws ServiceException, bea.jolt.JoltVersionException
name
- The service names
- The session objectversion
- The version number
ServiceException
- Invalid session, the service does not
exist, or is not exported.
JoltVersionException
- No such version.Method Detail |
public void done()
public int getRequestType()
getRequestType
in interface bea.jolt.Request
public java.lang.String getName()
getName
in interface bea.jolt.Request
public int getApplicationCode()
public JoltDefinition getDefinition()
JoltDefinition
public void call(bea.jolt.Transaction trans) throws ServiceException, TransactionException, ApplicationException
trans
- The transaction object or null
ServiceException
- Tuxedo system level error has occurred.
TransactionException
- Invalid transaction object, the
transaction has been suspended or aborted, or time-out has
occurred.
ApplicationException
- Application level error has occurred.clear()
,
JoltTransaction
public void call(bea.jolt.Transaction trans, java.lang.String principal, java.lang.String realm) throws ServiceException, TransactionException, ApplicationException
ServiceException
TransactionException
ApplicationException
public java.lang.String toString()
public void clear()
clear
in interface Message
public void addByte(java.lang.String name, byte val)
addByte
in interface Message
name
- The name of the item.val
- The byte value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void addShort(java.lang.String name, short val)
addShort
in interface Message
name
- The name of the item.val
- The short value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void addInt(java.lang.String name, int val)
addInt
in interface Message
name
- The name of the item.val
- The int value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void addFloat(java.lang.String name, float val)
addFloat
in interface Message
name
- The name of the item.val
- The float value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void addDouble(java.lang.String name, double val)
addDouble
in interface Message
name
- The name of the item.val
- The double value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void addString(java.lang.String name, java.lang.String val)
addString
in interface Message
name
- The name of the item.val
- The string value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void addBytes(java.lang.String name, byte[] val, int len)
addBytes
in interface Message
name
- The name of the item.val
- The byte-array value.len
- The number of bytes to be added.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void addMBString(java.lang.String name, java.lang.String val)
addMBString
in interface Message
name
- The name of the item.val
- The mbstring value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setByte(java.lang.String name, byte val)
setByte
in interface Message
name
- The name of the item.val
- The byte value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setShort(java.lang.String name, short val)
setShort
in interface Message
name
- The name of the item.val
- The short value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setInt(java.lang.String name, int val)
setInt
in interface Message
name
- The name of the item.val
- The int value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setFloat(java.lang.String name, float val)
setFloat
in interface Message
name
- The name of the item.val
- The float value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setDouble(java.lang.String name, double val)
setDouble
in interface Message
name
- The name of the item.val
- The double value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setString(java.lang.String name, java.lang.String val)
setString
in interface Message
name
- The name of the item.val
- The string value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setBytes(java.lang.String name, byte[] val, int len)
setBytes
in interface Message
name
- The name of the item.val
- The byte-array value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setMBString(java.lang.String name, java.lang.String val)
setMBString
in interface Message
name
- The name of the item.val
- The mbstring value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setByteItem(java.lang.String name, int itemNo, byte val)
setByteItem
in interface Message
name
- The name of the item.itemNo
- The occurrence number.val
- The byte value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setShortItem(java.lang.String name, int itemNo, short val)
setShortItem
in interface Message
name
- The name of the item.itemNo
- The occurrence number.val
- The short value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setIntItem(java.lang.String name, int itemNo, int val)
setIntItem
in interface Message
name
- The name of the item.itemNo
- The occurrence number.val
- The int value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setFloatItem(java.lang.String name, int itemNo, float val)
setFloatItem
in interface Message
name
- The name of the item.itemNo
- The occurrence number.val
- The float value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setDoubleItem(java.lang.String name, int itemNo, double val)
setDoubleItem
in interface Message
name
- The name of the item.itemNo
- The occurrence number.val
- The double value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setStringItem(java.lang.String name, int itemNo, java.lang.String val)
setStringItem
in interface Message
name
- The name of the item.itemNo
- The occurrence number.val
- The string value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setBytesItem(java.lang.String name, int itemNo, byte[] val, int len)
setBytesItem
in interface Message
name
- The name of the item.itemNo
- The occurrence number.val
- The byte-array value.len
- The length of the byte-array.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void setMBStringItem(java.lang.String name, int itemNo, java.lang.String val)
setMBStringItem
in interface Message
name
- The name of the item.itemNo
- The occurrence number.val
- The mbstring value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an output field.public void delete(java.lang.String name)
delete
in interface Message
name
- The name of the item.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public void deleteItem(java.lang.String name, int itemNo)
deleteItem
in interface Message
name
- The name of the item.itemNo
- The occurrence number.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public int getOccurrenceCount(java.lang.String name)
getOccurrenceCount
in interface Message
name
- The name of the item.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public byte getByteDef(java.lang.String name, byte def)
getByteDef
in interface Message
name
- The name fo the item.def
- The default byte value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public short getShortDef(java.lang.String name, short def)
getShortDef
in interface Message
name
- The name fo the item.def
- The default short value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public int getIntDef(java.lang.String name, int def)
getIntDef
in interface Message
name
- The name fo the item.def
- The default int value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public float getFloatDef(java.lang.String name, float def)
getFloatDef
in interface Message
name
- The name fo the item.def
- The default float value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public double getDoubleDef(java.lang.String name, double def)
getDoubleDef
in interface Message
name
- The name fo the item.def
- The default double value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public java.lang.String getStringDef(java.lang.String name, java.lang.String def)
getStringDef
in interface Message
name
- The name fo the item.def
- The default string value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public java.lang.String getMBStringDef(java.lang.String name, java.lang.String def)
getMBStringDef
in interface Message
name
- The name fo the item.def
- The default mbstring value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public byte[] getBytesDef(java.lang.String name, byte[] def)
getBytesDef
in interface Message
name
- The name fo the item.def
- The default byte-array value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public byte getByteItemDef(java.lang.String name, int itemNo, byte def)
getByteItemDef
in interface Message
name
- The name of the item.itemNo
- The occurrence number.def
- The default byte value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public short getShortItemDef(java.lang.String name, int itemNo, short def)
getShortItemDef
in interface Message
name
- The name of the item.itemNo
- The occurrence number.def
- The default short value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public int getIntItemDef(java.lang.String name, int itemNo, int def)
getIntItemDef
in interface Message
name
- The name of the item.itemNo
- The occurrence number.def
- The default int value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public float getFloatItemDef(java.lang.String name, int itemNo, float def)
getFloatItemDef
in interface Message
name
- The name of the item.itemNo
- The occurrence number.def
- The default float value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public double getDoubleItemDef(java.lang.String name, int itemNo, double def)
getDoubleItemDef
in interface Message
name
- The name of the item.itemNo
- The occurrence number.def
- The default double value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public java.lang.String getStringItemDef(java.lang.String name, int itemNo, java.lang.String def)
getStringItemDef
in interface Message
name
- The name of the item.itemNo
- The occurrence number.def
- The default string value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public byte[] getBytesItemDef(java.lang.String name, int itemNo, byte[] def)
getBytesItemDef
in interface Message
name
- The name of the item.itemNo
- The occurrence number.def
- The default byte-array value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public java.lang.String getMBStringItemDef(java.lang.String name, int itemNo, java.lang.String def)
getMBStringItemDef
in interface Message
name
- The name of the item.itemNo
- The occurrence number.def
- The default mbstring value.
java.lang.NoSuchFieldError
- It is an invalid name.
java.lang.IllegalAccessError
- It is not an input field.public JoltMessage getInputs()
JoltMessage
public JoltMessage getOutputs()
JoltMessage
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |