net.java.sip.communicator.plugin.jabberaccregwizz
Class JabberAccountRegistrationWizard

java.lang.Object
  net.java.sip.communicator.service.gui.AccountRegistrationWizard
      net.java.sip.communicator.plugin.jabberaccregwizz.JabberAccountRegistrationWizard

Direct Known Subclasses:

FacebookAccountRegistrationWizard, GoogleTalkAccountRegistrationWizard

public class JabberAccountRegistrationWizard
extends AccountRegistrationWizard

The JabberAccountRegistrationWizard is an implementation of the AccountRegistrationWizard for the Jabber protocol. It should allow the user to create and configure a new Jabber account.

Author:

Yana Stamcheva

Constructor Summary

JabberAccountRegistrationWizard(WizardContainer wizardContainer)
Creates an instance of JabberAccountRegistrationWizard.

Method Summary

String	getAccountIconPath() Returns the account icon path.
protected String	getCreateAccountButtonLabel() Return the string for add existing account button.
protected String	getCreateAccountLabel() Return the string for create new account button.
protected JabberAccountCreationFormService	getCreateAccountService() Returns an instance of CreateAccountService through which the user could create an account.
protected String	getExistingAccountLabel() Return the string for add existing account button.
Object	getFirstPageIdentifier() Returns the identifier of the page to show first in the wizard.
protected String	getHomeLinkLabel() Return the string for home page link label.
byte[]	getIcon() Implements the AccountRegistrationWizard.getIcon method.
Object	getLastPageIdentifier() Returns the identifier of the page to show last in the wizard.
byte[]	getPageImage() Implements the AccountRegistrationWizard.getPageImage method.
Iterator<WizardPage>	getPages() Returns the set of pages contained in this wizard.
Iterator<WizardPage>	getPages(JabberAccountRegistration registration) Returns the set of pages contained in this wizard.
String	getProtocol() Returns the protocol name as listed in "ProtocolNames" or just the name of the service.
String	getProtocolDescription() Implements the AccountRegistrationWizard.getProtocolDescription method.
String	getProtocolIconPath() Returns the protocol icon path.
String	getProtocolName() Implements the AccountRegistrationWizard.getProtocolName method.
JabberAccountRegistration	getRegistration() Returns the registration object, which will store all the data through the wizard.
protected String	getServerFromUserName(String userName) Parse the server part from the jabber id and set it to server as default value.
Object	getSimpleForm(boolean isCreateAccount) Returns a simple account registration form that would be the first form shown to the user.
Object	getSimpleForm(JabberAccountRegistration registration, boolean isCreateAccount) Returns the first wizard page.
Dimension	getSize() Returns the size of this wizard.
Iterator<Map.Entry<String,String>>	getSummary() Returns the set of data that user has entered through this wizard.
String	getUserNameExample() Returns an example string, which should indicate to the user how the user name should look like.
protected String	getUsernameLabel() Returns the display label used for the jabber id field.
protected ProtocolProviderService	installAccount(ProtocolProviderFactory providerFactory, String userName, String passwd) Creates an account for the given user and password.
boolean	isWebSignupSupported() Returns true if the web sign up is supported by the current implementation, false - otherwise.
void	loadAccount(ProtocolProviderService protocolProvider) Fills the User ID and Password fields in this panel with the data coming from the given protocolProvider.
ProtocolProviderService	signin() Installs the account defined in this wizard.
ProtocolProviderService	signin(String userName, String password) Installs the account defined in this wizard.
void	webSignup() Opens the Gmail signup URI in the OS's default browser.

Methods inherited from class net.java.sip.communicator.service.gui.AccountRegistrationWizard

accountRemoved, getForgotPasswordLink, getForgotPasswordLinkName, getWizardContainer, isHidden, isModification, isPreferredProtocol, isSimpleFormEnabled, setModification, setWizardContainer

Methods inherited from class java.lang.Object

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

Constructor Detail

JabberAccountRegistrationWizard

public JabberAccountRegistrationWizard(WizardContainer wizardContainer)

Creates an instance of JabberAccountRegistrationWizard.

Parameters:

wizardContainer - the wizard container, where this wizard is added

Method Detail

getIcon

public byte[] getIcon()

Implements the AccountRegistrationWizard.getIcon method. Returns the icon to be used for this wizard.

Specified by:

getIcon in class AccountRegistrationWizard

Returns:

byte[]

getPageImage

public byte[] getPageImage()

Implements the AccountRegistrationWizard.getPageImage method. Returns the image used to decorate the wizard page

Specified by:

getPageImage in class AccountRegistrationWizard

Returns:

byte[] the image used to decorate the wizard page

getProtocolName

public String getProtocolName()

Implements the AccountRegistrationWizard.getProtocolName method. Returns the protocol name for this wizard.

Specified by:

getProtocolName in class AccountRegistrationWizard

Returns:

String

getProtocolDescription

public String getProtocolDescription()

Implements the AccountRegistrationWizard.getProtocolDescription method. Returns the description of the protocol for this wizard.

Specified by:

getProtocolDescription in class AccountRegistrationWizard

Returns:

String

getPages

public Iterator<WizardPage> getPages()

Returns the set of pages contained in this wizard.

Specified by:

getPages in class AccountRegistrationWizard

Returns:

Iterator

getPages

public Iterator<WizardPage> getPages(JabberAccountRegistration registration)

Returns the set of pages contained in this wizard.

Parameters:

registration - the registration object

Returns:

Iterator

getSummary

public Iterator<Map.Entry<String,String>> getSummary()

Returns the set of data that user has entered through this wizard.

Specified by:

getSummary in class AccountRegistrationWizard

Returns:

Iterator

signin

public ProtocolProviderService signin()
                               throws OperationFailedException

Installs the account defined in this wizard.

Specified by:

signin in class AccountRegistrationWizard

Returns:

the created ProtocolProviderService corresponding to the new account

Throws:

OperationFailedException - if the operation didn't succeed

signin

public ProtocolProviderService signin(String userName,
                                      String password)
                               throws OperationFailedException

Installs the account defined in this wizard.

Specified by:

signin in class AccountRegistrationWizard

Parameters:

userName - the user name to sign in with

password - the password to sign in with

Returns:

the created ProtocolProviderService corresponding to the new account

Throws:

OperationFailedException - if the operation didn't succeed

installAccount

protected ProtocolProviderService installAccount(ProtocolProviderFactory providerFactory,
                                                 String userName,
                                                 String passwd)
                                          throws OperationFailedException

Creates an account for the given user and password.

Parameters:

providerFactory - the ProtocolProviderFactory which will create the account

userName - the user identifier

passwd - the password

Returns:

the ProtocolProviderService for the new account.

Throws:

OperationFailedException - if the operation didn't succeed

loadAccount

public void loadAccount(ProtocolProviderService protocolProvider)

Fills the User ID and Password fields in this panel with the data coming from the given protocolProvider.

Specified by:

loadAccount in class AccountRegistrationWizard

Parameters:

protocolProvider - The ProtocolProviderService to load the data from.

getRegistration

public JabberAccountRegistration getRegistration()

Returns the registration object, which will store all the data through the wizard.

Returns:

the registration object, which will store all the data through the wizard

getSize

public Dimension getSize()

Returns the size of this wizard.

Specified by:

getSize in class AccountRegistrationWizard

Returns:

the size of this wizard

getFirstPageIdentifier

public Object getFirstPageIdentifier()

Returns the identifier of the page to show first in the wizard.

Specified by:

getFirstPageIdentifier in class AccountRegistrationWizard

Returns:

the identifier of the page to show first in the wizard.

getLastPageIdentifier

public Object getLastPageIdentifier()

Returns the identifier of the page to show last in the wizard.

Specified by:

getLastPageIdentifier in class AccountRegistrationWizard

Returns:

the identifier of the page to show last in the wizard.

getUserNameExample

public String getUserNameExample()

Returns an example string, which should indicate to the user how the user name should look like.

Specified by:

getUserNameExample in class AccountRegistrationWizard

Returns:

an example string, which should indicate to the user how the user name should look like.

getServerFromUserName

protected String getServerFromUserName(String userName)

Parse the server part from the jabber id and set it to server as default value. If Advanced option is enabled Do nothing.

Parameters:

userName - the full JID that we'd like to parse.

Returns:

returns the server part of a full JID

webSignup

public void webSignup()

Opens the Gmail signup URI in the OS's default browser.

Overrides:

webSignup in class AccountRegistrationWizard

isWebSignupSupported

public boolean isWebSignupSupported()

Returns true if the web sign up is supported by the current implementation, false - otherwise.

Overrides:

isWebSignupSupported in class AccountRegistrationWizard

Returns:

true if the web sign up is supported by the current implementation, false - otherwise

getSimpleForm

public Object getSimpleForm(boolean isCreateAccount)

Returns a simple account registration form that would be the first form shown to the user. Only if the user needs more settings she'll choose to open the advanced wizard, consisted by all pages.

Specified by:

getSimpleForm in class AccountRegistrationWizard

Parameters:

isCreateAccount - indicates if the simple form should be opened as a create account form or as a login form

Returns:

a simple account registration form

getSimpleForm

public Object getSimpleForm(JabberAccountRegistration registration,
                            boolean isCreateAccount)

Returns the first wizard page.

Parameters:

registration - the registration object

isCreateAccount - indicates if the simple form should be opened as a create account form or as a login form

Returns:

the first wizard page.

getProtocol

public String getProtocol()

Returns the protocol name as listed in "ProtocolNames" or just the name of the service.

Returns:

the protocol name

getProtocolIconPath

public String getProtocolIconPath()

Returns the protocol icon path.

Returns:

the protocol icon path

getAccountIconPath

public String getAccountIconPath()

Returns the account icon path.

Returns:

the account icon path

getCreateAccountService

protected JabberAccountCreationFormService getCreateAccountService()

Returns an instance of CreateAccountService through which the user could create an account. This method is meant to be implemented by specific protocol provider wizards.

Returns:

an instance of CreateAccountService

getUsernameLabel

protected String getUsernameLabel()

Returns the display label used for the jabber id field.

Returns:

the jabber id display label string.

getCreateAccountButtonLabel

protected String getCreateAccountButtonLabel()

Return the string for add existing account button.

Returns:

the string for add existing account button.

getCreateAccountLabel

protected String getCreateAccountLabel()

Return the string for create new account button.

Returns:

the string for create new account button.

getExistingAccountLabel

protected String getExistingAccountLabel()

Return the string for add existing account button.

Returns:

the string for add existing account button.

getHomeLinkLabel

protected String getHomeLinkLabel()

Return the string for home page link label.

Returns:

the string for home page link label