Package com.isode.x400api

Class Session

  • public class Session
extends java.lang.Object
    Provides the Session class used by the X.400 class. Hold sessions information to pass across the API in an opaque manner.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String ret_str  

    • Constructor Summary

      Constructors 
      Constructor Description
      Session()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cancelWait()
      If this Session is waiting for new messages to arrive, cause the wait to terminate.
      void enableWait()
      Enable this session to wait for messages again.
      int GetNumMsgs()
      Returns the number of messages waiting from the most recent MSOpen call.
      boolean GetSummarizeOnBind()
      Returns true if summarize on binds are set
      void SetSummarizeOnBind​(boolean val)
      When binding to the Message Store, by default it checks the number of messages that are available to be read (regardless of their status).

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ret_str

        public java.lang.String ret_str

    • Constructor Detail

      • Session

        public Session()

    • Method Detail

      • GetNumMsgs

        public int GetNumMsgs()
        Returns the number of messages waiting from the most recent MSOpen call.

      • SetSummarizeOnBind

        public void SetSummarizeOnBind​(boolean val)
        When binding to the Message Store, by default it checks the number of messages that are available to be read (regardless of their status). This operation can be quite expensive if there are lots of messages in the mailbox. If you want to speed up the bind operation, then set SetSummarizeOnBind(false). The default is SetSummarizeOnBind(true). If you want to find out how many messages are available, use GetNumMsgs()

      • GetSummarizeOnBind

        public boolean GetSummarizeOnBind()
        Returns true if summarize on binds are set

      • cancelWait

        public void cancelWait()
        If this Session is waiting for new messages to arrive, cause the wait to terminate.

      • enableWait

        public void enableWait()
        Enable this session to wait for messages again.