|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.compoze.domino.Session
This class represents a session to the Compoze Domino Service. The session can connect to the service using any implemented protocol.
Methods names that begin with the string server
(as well as
the close
method) require a query to the server to be completed.
Because each query involves some overhead, keeping the number of queries to
a minimum and doing as much as possible in one query will improve the
performance of the application.
Field Summary | |
static java.lang.String |
PROP_DOMINO_LOOKUP_SERVER
The name of a machine in the Notes domain that will be used to lookup the specified user's mailbox information, such as database and server name to connect to (optional, leave blank to use the same machine as the Domino Service). |
static java.lang.String |
PROP_DOMINO_MAILBOX
The name of a mailbox to connect to (optional). |
static java.lang.String |
PROP_DOMINO_VERSION_CHECK
The flag to check for version conflict between the connector and the service. |
static java.lang.String |
PROP_PROXY_PASSWORD
The password used to log into the proxy server (optional). |
static java.lang.String |
PROP_PROXY_URL
The hostname of the proxy server as it can be resolved from the machine you are running this exerciser on. |
static java.lang.String |
PROP_PROXY_USERNAME
The username used to log into the proxy server (optional). |
static java.lang.String |
PROP_SERVICE_URL
The hostname of the Compoze Domino Service machine as it can be resolved from the machine you are running this exerciser on (required). |
static java.lang.String |
PROP_USER_PASSWORD
The Internet password of the user that will access the Domino mailbox (required). |
static java.lang.String |
PROP_USER_USERNAME
The username of the user that will access the Domino mailbox (required). |
Constructor Summary | |
Session(java.util.Properties connectionProps)
Constructor. |
Method Summary | |
void |
close()
Closes the session to the Domino server. |
java.lang.String |
endTrace()
Ends tracing calls to the server and returns a string showing all calls that were made since tracing was started. |
AddressBooks |
getAddressBooks()
Gets an instance of a class used to manipulate address books for the session. |
long |
getAttachmentSizeLimit()
Gets the attachment size limit (in bytes). |
double |
getAttachmentSizeLimitInKilos()
Gets the attachment size limit (in kilosbytes). |
Documents |
getDocuments()
Gets an instance of a class used to manipulate documents for the session. |
Folders |
getFolders()
Gets an instance of a class used to manipulate folders for the session. |
java.lang.String |
getID()
Gets a unique ID for the session (only unique to the server the session is connected to). |
java.lang.String |
getMailbox()
Gets the mailbox for the session. |
java.lang.String |
getServiceURL()
Gets the Compoze Domino Service URL for the session. |
java.util.TimeZone |
getTimeZone()
Gets the time zone for this session. |
UserInfo |
getUserInfo()
Gets the user info for the session. |
void |
serverCheck()
Hits the server and checks if the session has expired. |
void |
setTimeZone(java.util.TimeZone timeZone)
Sets the time zone for this session. |
void |
startTrace()
Starts tracing calls to the server (verbose). |
void |
startTrace(boolean bVerbose)
Starts tracing calls to the server. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String PROP_SERVICE_URL
public static final java.lang.String PROP_USER_USERNAME
public static final java.lang.String PROP_USER_PASSWORD
public static final java.lang.String PROP_DOMINO_MAILBOX
public static final java.lang.String PROP_PROXY_URL
public static final java.lang.String PROP_PROXY_USERNAME
public static final java.lang.String PROP_PROXY_PASSWORD
public static final java.lang.String PROP_DOMINO_VERSION_CHECK
public static final java.lang.String PROP_DOMINO_LOOKUP_SERVER
Constructor Detail |
public Session(java.util.Properties connectionProps) throws DominoException
Note: DominoACLException
is thrown if the specified
user and password credentials do not have adequate permission
to access the specified mailbox.
Note: UserPasswordException
is thrown if the user and/or
password is incorrect.
Note: NoMailboxException
is thrown if the user's mailbox
does not exist. This could be due to the user not having a Notes mailbox.
connectionProps
- the connection properties to authenticate against Domino (see PROP_
constants)DominoException
- occurs if an exception occurs while connecting to DominoMethod Detail |
public Folders getFolders()
public Documents getDocuments()
public java.util.TimeZone getTimeZone()
public void setTimeZone(java.util.TimeZone timeZone)
timeZone
- the time zone (may not be null
)public AddressBooks getAddressBooks()
public java.lang.String getID() throws DominoException
public long getAttachmentSizeLimit()
public double getAttachmentSizeLimitInKilos()
public java.lang.String getMailbox()
PROP_DOMINO_MAILBOX
public UserInfo getUserInfo()
public java.lang.String getServiceURL()
PROP_SERVICE_URL
public void close() throws DominoException
public void serverCheck() throws DominoException
DominoException
- occurs if the session has expiredpublic void startTrace()
public void startTrace(boolean bVerbose)
bVerbose
- if true
, trace data sent and
received, otherwise just trace elapsed time and number of requestspublic java.lang.String endTrace()
startTrace()
was called
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |