net.java.sip.communicator.impl.protocol.irc
Class ProtocolProviderServiceIrcImpl

java.lang.Object
  net.java.sip.communicator.service.protocol.AbstractProtocolProviderService
      net.java.sip.communicator.impl.protocol.irc.ProtocolProviderServiceIrcImpl

All Implemented Interfaces:

ProtocolProviderService

public class ProtocolProviderServiceIrcImpl
extends AbstractProtocolProviderService

An IRC implementation of the ProtocolProviderService.

Author:

Loic Kempf, Stephane Remy

Field Summary

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

BIND_RETRIES_DEFAULT_VALUE, BIND_RETRIES_PROPERTY_NAME

Constructor Summary

ProtocolProviderServiceIrcImpl()
The default constructor for the IRC protocol provider.

Method Summary

AccountID	getAccountID() Returns the AccountID that uniquely identifies the account represented by this instance of the ProtocolProviderService.
protected RegistrationState	getCurrentRegistrationState() Returns the current registration state of this protocol provider.
IrcStack	getIrcStack() Returns the IRC stack implementation.
ProtocolIcon	getProtocolIcon() Returns the icon for this protocol.
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.
TransportProtocol	getTransportProtocol() Returns the "transport" protocol of this instance used to carry the control channel for the current protocol service.
protected void	initialize(String userID, AccountID accountID) Initializes the service implementation, and puts it in a sate where it could operate with other services.
boolean	isSignalingTransportSecure() Indicate if the signaling transport of this protocol instance uses a secure (e.g.
void	register(SecurityAuthority authority) Starts the registration process.
protected void	setCurrentRegistrationState(RegistrationState regState) Sets the current registration state of this protocol provider.
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

Constructor Detail

ProtocolProviderServiceIrcImpl

public ProtocolProviderServiceIrcImpl()

The default constructor for the IRC 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 operate with other services. It is strongly recommended that properties in this Map be mapped to property names as specified by AccountProperties.

Parameters:

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

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

See Also:

AccountID

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).

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()

Description copied from interface: ProtocolProviderService

Indicate if the signaling transport of this protocol instance uses a secure (e.g. via TLS) connection.

Returns:

True when the connection is secured, false otherwise.

getTransportProtocol

public TransportProtocol getTransportProtocol()

Returns the "transport" protocol of this instance used to carry the control channel for the current protocol service.

Returns:

The "transport" protocol of this instance: TCP.

getProtocolIcon

public ProtocolIcon getProtocolIcon()

Returns the icon for this protocol.

Returns:

the icon for this protocol

getIrcStack

public IrcStack getIrcStack()

Returns the IRC stack implementation.

Returns:

the IRC stack implementation.

getCurrentRegistrationState

protected RegistrationState getCurrentRegistrationState()

Returns the current registration state of this protocol provider.

Returns:

the current registration state of this protocol provider

setCurrentRegistrationState

protected void setCurrentRegistrationState(RegistrationState regState)

Sets the current registration state of this protocol provider.

Parameters:

regState - the new registration state to set