com.borland.vbroker.NativeMessaging
Class RequestDesc

java.lang.Object
  com.borland.vbroker.NativeMessaging.RequestDesc

All Implemented Interfaces:

java.io.Serializable, IDLEntity

public final class RequestDesc
extends java.lang.Object
implements IDLEntity

Structure containing all the information needed to service an async request. Used by the RequestAgent.create_request method.

See Also:

Serialized Form

Field Summary

java.lang.String	polling_group A user assigned polling group name.
NameValuePair[]	properties Sequence of CORBA::NameValuePair.
ReplyRecipient	reply_recipient Reference of the reply recipient when callback model is used.
java.lang.String	repository_id Repository id of the target object.
byte[]	request_tag User assigned sequence of octets.
Object	target Reference of the target object upon which the client wish to invoke the operation.
byte[]	the_cookie A user specified sequence of octets.

Constructor Summary

RequestDesc()

RequestDesc(Object target, java.lang.String repository_id, ReplyRecipient reply_recipient, byte[] the_cookie, java.lang.String polling_group, byte[] request_tag, NameValuePair[] properties)

Method Summary

boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

target

public Object target

Reference of the target object upon which the client wish to invoke the operation. CORBA::BAD_PARAM exception will be raised if a null value for reference is passed.

repository_id

public java.lang.String repository_id

Repository id of the target object. If this is an empty string, Request Agent will try to extract the repository id from the target object reference. If no repository id can be found in the target object reference, a CORBA::BAD_PARAM exception is raised. Clients can also use a repository id of "*". This acts as a wild card and is_a operation on the request object returns true for any repository id.

reply_recipient

public ReplyRecipient reply_recipient

Reference of the reply recipient when callback model is used. If this reference is not null then the Request Agent will call its reply_available method when a reply is ready.

the_cookie

public byte[] the_cookie

A user specified sequence of octets. It will be sent to the reply_recipient when its method reply_available is called. The information inside the cookie is user defined.

polling_group

public java.lang.String polling_group

A user assigned polling group name. The group name is scoped inside the Request Agent. Group names are not uniquely used. If a non-empty group name is used and the Request Agent doesn't have a polling group with that name, a new group will be implicitly created. However, if a group with the specified name already exists, the created request object is added into that group.

request_tag

public byte[] request_tag

User assigned sequence of octets. If non-empty, it uniquely identifies a request in a polling group. If another request in the polling group already exists with the same tag, the DuplicatedRequestTag exception is raised.

properties

public NameValuePair[] properties

Sequence of CORBA::NameValuePair.

Note: Starting from VBE 6.0, the properties field is defined as CORBA::NameValuePair. Applications using Native Messaging from VBE 5.1/5.2.x are wire interoperable with VBE 6.0 Request Agent (and vice versa). However, code changes are required if an older Native Messaging application is to be compiled with VBE 6.0..

Constructor Detail

RequestDesc

public RequestDesc()

RequestDesc

public RequestDesc(Object target,
                   java.lang.String repository_id,
                   ReplyRecipient reply_recipient,
                   byte[] the_cookie,
                   java.lang.String polling_group,
                   byte[] request_tag,
                   NameValuePair[] properties)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object