net.java.sip.communicator.impl.protocol.dict
Class ProtocolProviderServiceDictImpl

java.lang.Object
  net.java.sip.communicator.service.protocol.AbstractProtocolProviderService
      net.java.sip.communicator.impl.protocol.dict.ProtocolProviderServiceDictImpl

All Implemented Interfaces:

ProtocolProviderService

public class ProtocolProviderServiceDictImpl
extends AbstractProtocolProviderService

A Dict implementation of the ProtocolProviderService.

Author:

ROTH Damien, LITZELMANN Cedric

Field Summary

static String

DICT_PROTOCOL_NAME The name of this protocol.

Fields inherited from interface net.java.sip.communicator.service.protocol.ProtocolProviderService

BIND_RETRIES_DEFAULT_VALUE, BIND_RETRIES_PROPERTY_NAME

Constructor Summary

ProtocolProviderServiceDictImpl()
The default constructor for the Dict protocol provider.

Method Summary

AccountID	getAccountID() Returns the AccountID that uniquely identifies the account represented by this instance of the ProtocolProviderService.
net.java.dict4j.DictConnection	getConnection() Returns the DictConnection opened by this provider
ProtocolIcon	getProtocolIcon() Returns the dict protocol icon.
String	getProtocolName() Returns the short name of the protocol that the implementation of this provider is based upon (like SIP, Jabber, ICQ/AIM, or others for example).
RegistrationState	getRegistrationState() Returns the state of the registration of this protocol provider with the corresponding registration service.
protected void	initialize(String userID, AccountID accountID) Initializes the service implementation, and puts it in a sate where it could interoperate with other services.
boolean	isSignalingTransportSecure() DICT has no support for secure transport.
void	register(SecurityAuthority authority) Starts the registration process.
void	shutdown() Makes the service implementation close all open sockets and release any resources that it might have taken and prepare for shutdown/garbage collection.
void	unregister() Ends the registration of this protocol provider with the current registration service.

Methods inherited from class net.java.sip.communicator.service.protocol.AbstractProtocolProviderService

addRegistrationStateChangeListener, addSupportedOperationSet, clearRegistrationStateChangeListener, fireRegistrationStateChanged, getOperationSet, getProtocolDisplayName, getSupportedOperationSets, isRegistered, removeRegistrationStateChangeListener, removeSupportedOperationSet, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.java.sip.communicator.service.protocol.ProtocolProviderService

hashCode

Field Detail

DICT_PROTOCOL_NAME

public static final String DICT_PROTOCOL_NAME

The name of this protocol.

See Also:

Constant Field Values

Constructor Detail

ProtocolProviderServiceDictImpl

public ProtocolProviderServiceDictImpl()

The default constructor for the Dict protocol provider.

Method Detail

initialize

protected void initialize(String userID,
                          AccountID accountID)

Initializes the service implementation, and puts it in a sate where it could interoperate with other services. It is strongly recomended that properties in this Map be mapped to property names as specified by AccountProperties.

Parameters:

userID - the user id of the gibberish account we're currently initializing

accountID - the identifier of the account that this protocol provider represents.

See Also:

AccountID

getConnection

public net.java.dict4j.DictConnection getConnection()

Returns the DictConnection opened by this provider

Returns:

the DictConnection opened by this provider

getAccountID

public AccountID getAccountID()

Returns the AccountID that uniquely identifies the account represented by this instance of the ProtocolProviderService.

Returns:

the id of the account represented by this provider.

getProtocolName

public String getProtocolName()

Returns the short name of the protocol that the implementation of this provider is based upon (like SIP, Jabber, ICQ/AIM, or others for example).

Returns:

a String containing the short name of the protocol this service is implementing (most often that would be a name in ProtocolNames).

getProtocolIcon

public ProtocolIcon getProtocolIcon()

Returns the dict protocol icon.

Returns:

the dict protocol icon

getRegistrationState

public RegistrationState getRegistrationState()

Returns the state of the registration of this protocol provider with the corresponding registration service.

Returns:

ProviderRegistrationState

register

public void register(SecurityAuthority authority)
              throws OperationFailedException

Starts the registration process.

Parameters:

authority - the security authority that will be used for resolving any security challenges that may be returned during the registration or at any moment while wer're registered.

Throws:

OperationFailedException - with the corresponding code it the registration fails for some reason (e.g. a networking error or an implementation problem).

shutdown

public void shutdown()

Makes the service implementation close all open sockets and release any resources that it might have taken and prepare for shutdown/garbage collection.

unregister

public void unregister()
                throws OperationFailedException

Ends the registration of this protocol provider with the current registration service.

Throws:

OperationFailedException - with the corresponding code it the registration fails for some reason (e.g. a networking error or an implementation problem).

isSignalingTransportSecure

public boolean isSignalingTransportSecure()

DICT has no support for secure transport.

Returns:

True when the connection is secured, false otherwise.