com.zion.jbuddy
Interface ILcsClient

All Superinterfaces:

IClient

public interface ILcsClient
extends IClient

Provides access to features specific to LCS (Microsoft's Live Communications Server).

An IClient can be casted to an ILcsClient if the specified protocol is LCS.

// creates an ILcsClient IClient client = IClientFactory.factory(gateway, IClient.LCS, username, password); ILcsClient lcsClient = (ILcsClient)client;

Since:

6.0

Field Summary

Fields inherited from interface com.zion.jbuddy.IClient

AIM, CONNECTION_CLOSED_REASON, DISCONNECT_REASON, FAILED_LOGIN_REASON, ICQ, JABBER, JSC, LCS, MSN, NETWORK_ERROR_REASON, PLAIN_TEXT, RICH_TEXT, SAMETIME, SERVICE_TEMPORARILY_UNAVAILABLE_REASON, UNKNOWN_REASON, USER_BOOTED_REASON, YIM

Method Summary

void	endConversation(String name) Ends a conversation with a user.
IAddressBook	getAddressBook() Returns this client's Address Book.
IAddressBookProvider	getAddressBookProvider() Returns this client's Address Book Provider.
String	getLoginName() Returns the name used to authenticate this client with the server.
boolean	isSecure() Returns true if this client is connected to the server, and the connection is secure.
IBuddy[]	resolveBuddies(String partialName) Resolves a partial name to matching users from the LCS server's user directory.
void	setAddressBookProvider(IAddressBookProvider addressBookProvider) Sets this client's Address Book Provider.
void	setLoginName(String name) Sets the name used to authenticate this client with the server.
void	setSecure(boolean isSecure, boolean isRequired) Specifies whether a secure connection to the server should be used.

Methods inherited from interface com.zion.jbuddy.IClient

addBuddy, addBuddyToList, addDeny, addFileSessionInvitationListener, addGateway, addPermit, connect, connect, createFileSession, disconnect, getBuddyList, getConferenceService, getCustomAwayMessage, getDenyList, getIdleTimeStamp, getName, getNickName, getPassword, getPermitList, getPermitMode, getPlainTextMode, getProtocol, getProtocolName, getSignOnTimeStamp, getStatus, getStatusAsString, getStatusTimeStamp, isOnline, numberOfMessagesReceived, numberOfMessagesSent, removeBuddy, removeBuddyFromList, removeDeny, removeFileSessionInvitationListener, removeGateway, removePermit, sendConfigToServer, sendIM, sendMessage, setKeepAliveInterval, setNickName, setPermitMode, setPlainTextMode, setStatus

Method Detail

setLoginName

void setLoginName(String name)

Sets the name used to authenticate this client with the server.

The default Kerberos login name used for a user user@host.com is user@HOST.COM. If this is not correct for a user, a login name should be provided here.

getLoginName

String getLoginName()

Returns the name used to authenticate this client with the server.

setSecure

void setSecure(boolean isSecure,
               boolean isRequired)

Specifies whether a secure connection to the server should be used.

Valid for AIM, ICQ, JABBER, JSC, LCS.

This method will do nothing if it is called on a client that doesn't support TLS connections.

Specified by:

setSecure in interface IClient

Parameters:

isSecure - whether a secure connection to the server should be used. If this is true, when connecting, a TLS connection will be opened with the server.

isRequired - whether a secure connection to the server is required. If isSecure and isRequired are both true, connect() will only succeed if a secure connection was successfully established.

isSecure

boolean isSecure()

Returns true if this client is connected to the server, and the connection is secure.

Valid for AIM, ICQ, JABBER, JSC, LCS.

Specified by:

isSecure in interface IClient

endConversation

void endConversation(String name)

Ends a conversation with a user.

A session is automatically opened with a user when sending or receiving messages. This closes that session. Use this when the session is no longer needed (such as when closing a UI message window).

getAddressBookProvider

IAddressBookProvider getAddressBookProvider()

Returns this client's Address Book Provider.

Since:

6.3 (Java API only)

setAddressBookProvider

void setAddressBookProvider(IAddressBookProvider addressBookProvider)

Sets this client's Address Book Provider.

Parameters:

addressBookProvider - the Address Book Provider

Since:

6.3 (Java API only)

getAddressBook

IAddressBook getAddressBook()
                            throws Exception

Returns this client's Address Book.

The Address Book will be updated from the server (if possible) and returned. A failed update will not cause an exception to be thrown. This allows the locally saved Address Book to still be searched despite not being able to update for some reason.

Throws:

IOException - if some error occurred

Exception

Since:

6.3 (Java API only)

resolveBuddies

IBuddy[] resolveBuddies(String partialName)
                        throws IOException

Resolves a partial name to matching users from the LCS server's user directory.

Use this method to retrieve information about users (like their username or nickname).

Parameters:

partialName - part of a user's name (like their first or last name)

Returns:

the resolved buddies, or an empty array if there are no matches

Throws:

IOException - if there is a problem communicating with the directory service

Since:

6.3