|
All LDAP Classes Internal LDAP Classes |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.ldap.Message
class Message
Encapsulates an LDAP message, its state, and its replies.
Nested Class Summary | |
---|---|
private class |
Message.Timeout
Timer class to provide timing for messages. |
Field Summary | |
---|---|
private boolean |
acceptReplies
|
private MessageAgent |
agent
|
private BindProperties |
bindprops
|
private boolean |
complete
|
private Connection |
conn
|
private LDAPMessage |
msg
|
private int |
msgId
|
private int |
mslimit
|
private java.lang.String |
name
|
private LDAPMessageQueue |
queue
|
private MessageVector |
replies
|
private java.lang.Thread |
timer
|
private boolean |
waitForReply
|
Constructor Summary | |
---|---|
Message(LDAPMessage msg,
int mslimit,
Connection conn,
MessageAgent agent,
LDAPMessageQueue queue,
BindProperties bindprops)
Constructs a Message class encapsulating information about this message. |
Method Summary | |
---|---|
(package private) void |
abandon(LDAPConstraints cons,
InterThreadException informUserEx)
abandon a request. |
(package private) boolean |
acceptsReplies()
Returns true if replies are accepted for this request. |
private void |
cleanup()
Release reply messages |
protected void |
finalize()
finalize |
(package private) int |
getCount()
Get number of messages queued. |
(package private) MessageAgent |
getMessageAgent()
gets the MessageAgent associated with this message |
(package private) int |
getMessageID()
gets the Message ID associated with this message request |
(package private) int |
getMessageType()
gets the Message Type associated with this message request |
(package private) java.lang.Object |
getReply()
Gets the next reply from the reply queue if one exists |
(package private) LDAPMessage |
getRequest()
gets the LDAPMessage request associated with this message |
(package private) boolean |
hasReplies()
Returns true if replies are queued |
(package private) boolean |
isBindRequest()
Returns true if this message is a bind request |
(package private) boolean |
isComplete()
gets the operation complete status for this message |
(package private) void |
putReply(RfcLDAPMessage message)
Puts a reply on the reply queue |
(package private) void |
refuseReplies()
prevents future replies from being accepted for this request |
(package private) void |
sendMessage()
This method write the message on the wire. |
(package private) void |
setAgent(MessageAgent agent)
sets the agent for this message |
private void |
sleepersAwake()
Notifies all waiting threads |
(package private) void |
stopTimer()
stops the timeout timer from running |
(package private) java.lang.Object |
waitForReply()
Gets the next reply from the reply queue or waits until one is there |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private LDAPMessage msg
private Connection conn
private MessageAgent agent
private LDAPMessageQueue queue
private int mslimit
private java.lang.Thread timer
private MessageVector replies
private int msgId
private boolean acceptReplies
private boolean waitForReply
private boolean complete
private java.lang.String name
private BindProperties bindprops
Constructor Detail |
---|
Message(LDAPMessage msg, int mslimit, Connection conn, MessageAgent agent, LDAPMessageQueue queue, BindProperties bindprops)
msg
- the message to send to the server
mslimit
- number of milliseconds to wait before the message times out.
conn
- the connection used to send this message
agent
- the MessageAgent handling this message.
queue
- the application LDAPMessageQueue for this messageMethod Detail |
---|
final void sendMessage() throws LDAPException
LDAPException
boolean hasReplies()
int getCount()
boolean acceptsReplies()
void refuseReplies()
void setAgent(MessageAgent agent)
void stopTimer()
private void sleepersAwake()
boolean isComplete()
MessageAgent getMessageAgent()
LDAPMessage getRequest()
int getMessageID()
int getMessageType()
void putReply(RfcLDAPMessage message)
message
- the RfcLDAPMessage to put on the reply queue.java.lang.Object waitForReply()
java.lang.Object getReply()
void abandon(LDAPConstraints cons, InterThreadException informUserEx)
cons
- and LDAPConstraints associated with the abandon.
informUserEx
- true if user must be informed of operationprivate void cleanup()
final boolean isBindRequest()
protected final void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable
|
All LDAP Classes Internal LDAP Classes |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |