/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.java.sip.communicator.service.protocol.jabber;
import net.java.sip.communicator.service.protocol.*;
import java.util.*;
/**
* The Jabber implementation of a sip-communicator AccountID
*
* @author Damian Minkov
* @author Sebastien Vincent
* @author Pawel Domas
*/
public class JabberAccountID
extends AccountID
{
/**
* Default properties prefix used in jitsi-defaults.properties file
* for Jabber protocol.
*/
private static final String JBR_DEFAULTS_PREFIX
= AccountID.DEFAULTS_PREFIX +"jabber.";
/**
* Uses anonymous XMPP login if set to true.
*/
public static final String ANONYMOUS_AUTH = "ANONYMOUS_AUTH";
/**
* Configures the URL which is to be used with BOSH transport. If the value
* is null or empty then the TCP transport will be used instead.
*/
public static final String BOSH_URL = "BOSH_URL";
/**
* Account suffix for Google service.
*/
public static final String GOOGLE_USER_SUFFIX = "gmail.com";
/**
* XMPP server for Google service.
*/
public static final String GOOGLE_CONNECT_SRV = "talk.google.com";
/**
* The default value of stun server port for jabber accounts.
*/
public static final String DEFAULT_STUN_PORT = "3478";
/**
* Indicates if keep alive packets should be send.
*/
public static final String SEND_KEEP_ALIVE = "SEND_KEEP_ALIVE";
/**
* Indicates if gmail notifications should be enabled.
*/
public static final String GMAIL_NOTIFICATIONS_ENABLED
= "GMAIL_NOTIFICATIONS_ENABLED";
/**
* Always call with gtalk property.
*
* It is used to bypass capabilities checks: some softwares do not advertise
* GTalk support (but they support it).
*/
public static final String BYPASS_GTALK_CAPABILITIES
= "BYPASS_GTALK_CAPABILITIES";
/**
* Indicates if Google Contacts should be enabled.
*/
public static final String GOOGLE_CONTACTS_ENABLED
= "GOOGLE_CONTACTS_ENABLED";
/**
* Domain name that will bypass GTalk caps.
*/
public static final String TELEPHONY_BYPASS_GTALK_CAPS
= "TELEPHONY_BYPASS_GTALK_CAPS";
/**
* The override domain for phone call.
*
* If Jabber account is able to call PSTN number and if domain name of the
* switch is different than the domain of the account (gw.domain.org vs
* domain.org), you can use this property to set the switch domain.
*/
public static final String OVERRIDE_PHONE_SUFFIX
= "OVERRIDE_PHONE_SUFFIX";
/**
* Creates an account id from the specified id and account properties.
* @param id the id identifying this account
* @param accountProperties any other properties necessary for the account.
*/
public JabberAccountID(String id, Map accountProperties)
{
super( id, accountProperties,
ProtocolNames.JABBER,
getServiceName(accountProperties));
}
/**
* Default constructor for serialization purposes.
*/
public JabberAccountID()
{
this(null, new HashMap());
}
/**
* Returns the BOSH URL which should be used to connect to the XMPP server.
* If the value is set then BOSH transport instead of TCP will be used.
*
* @return a String with the URL which should be used for BOSH
* transport or null if disabled.
*/
public String getBoshUrl()
{
return getAccountPropertyString(BOSH_URL);
}
/**
* Sets new URL which should be used for the BOSH transport.
*
* @param boshPath a String with the new BOSH URL or null
* to disable BOSH.
*/
public void setBoshUrl(String boshPath)
{
putAccountProperty(BOSH_URL, boshPath);
}
/**
* Returns the override phone suffix.
*
* @return the phone suffix
*/
public String getOverridePhoneSuffix()
{
return getAccountPropertyString(OVERRIDE_PHONE_SUFFIX);
}
/**
* Returns the actual name of this protocol: {@link ProtocolNames#JABBER}.
*
* @return Jabber: the name of this protocol.
*/
public String getSystemProtocolName()
{
return ProtocolNames.JABBER;
}
/**
* Returns the alwaysCallWithGtalk value.
*
* @return the alwaysCallWithGtalk value
*/
public boolean getBypassGtalkCaps()
{
return getAccountPropertyBoolean(BYPASS_GTALK_CAPABILITIES, false);
}
/**
* Returns telephony domain that bypass GTalk caps.
*
* @return telephony domain
*/
public String getTelephonyDomainBypassCaps()
{
return getAccountPropertyString(TELEPHONY_BYPASS_GTALK_CAPS);
}
/**
* Indicates whether anonymous authorization method is used by this account.
* @return true if anonymous login is enabled on this account.
*/
public boolean isAnonymousAuthUsed()
{
return getAccountPropertyBoolean(ANONYMOUS_AUTH, false);
}
/**
* Gets if Jingle is disabled for this account.
*
* @return True if jingle is disabled for this account. False otherwise.
*/
public boolean isJingleDisabled()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.IS_CALLING_DISABLED_FOR_ACCOUNT, false);
}
/**
* Determines whether sending of keep alive packets is enabled.
*
* @return true if keep alive packets are to be sent for this
* account and false otherwise.
*/
public boolean isSendKeepAlive()
{
return getAccountPropertyBoolean(SEND_KEEP_ALIVE, true);
}
/**
* Determines whether SIP Communicator should be querying Gmail servers
* for unread mail messages.
*
* @return true if we are to enable Gmail notifications and
* false otherwise.
*/
public boolean isGmailNotificationEnabled()
{
return getAccountPropertyBoolean(GMAIL_NOTIFICATIONS_ENABLED, false);
}
/**
* Determines whether SIP Communicator should use Google Contacts as
* ContactSource
*
* @return true if we are to enable Google Contacts and
* false otherwise.
*/
public boolean isGoogleContactsEnabled()
{
return getAccountPropertyBoolean(GOOGLE_CONTACTS_ENABLED, true);
}
/**
* Enables anonymous authorization mode on this XMPP account.
* @param useAnonymousAuth true to use anonymous login.
*/
public void setUseAnonymousAuth(boolean useAnonymousAuth)
{
putAccountProperty(ANONYMOUS_AUTH, useAnonymousAuth);
}
/**
* Sets the override value of the phone suffix.
*
* @param phoneSuffix the phone name suffix (the domain name after the @
* sign)
*/
public void setOverridePhoneSufix(String phoneSuffix)
{
setOrRemoveIfEmpty(OVERRIDE_PHONE_SUFFIX, phoneSuffix);
}
/**
* Sets value for alwaysCallWithGtalk.
*
* @param bypassGtalkCaps true to enable, false otherwise
*/
public void setBypassGtalkCaps(boolean bypassGtalkCaps)
{
putAccountProperty(BYPASS_GTALK_CAPABILITIES, bypassGtalkCaps);
}
/**
* Sets telephony domain that bypass GTalk caps.
*
* @param text telephony domain to set
*/
public void setTelephonyDomainBypassCaps(String text)
{
setOrRemoveIfEmpty(TELEPHONY_BYPASS_GTALK_CAPS, text);
}
/**
* Sets if Jingle is disabled for this account.
*
* @param disabled True if jingle is disabled for this account.
* False otherwise.
*/
public void setDisableJingle(boolean disabled)
{
putAccountProperty(
ProtocolProviderFactory.IS_CALLING_DISABLED_FOR_ACCOUNT,
disabled );
}
/**
* Specifies whether SIP Communicator should send send keep alive packets
* to keep this account registered.
*
* @param sendKeepAlive true if we are to send keep alive packets
* and false otherwise.
*/
public void setSendKeepAlive(boolean sendKeepAlive)
{
putAccountProperty(SEND_KEEP_ALIVE, sendKeepAlive);
}
/**
* Specifies whether SIP Communicator should be querying Gmail servers
* for unread mail messages.
*
* @param enabled true if we are to enable Gmail notification and
* false otherwise.
*/
public void setGmailNotificationEnabled(boolean enabled)
{
putAccountProperty(GMAIL_NOTIFICATIONS_ENABLED, enabled);
}
/**
* Specifies whether SIP Communicator should use Google Contacts as
* ContactSource.
*
* @param enabled true if we are to enable Google Contacts and
* false otherwise.
*/
public void setGoogleContactsEnabled(boolean enabled)
{
putAccountProperty(GOOGLE_CONTACTS_ENABLED, enabled);
}
/**
* Returns the resource.
* @return the resource
*/
public String getResource()
{
return getAccountPropertyString(ProtocolProviderFactory.RESOURCE);
}
/**
* Sets the resource.
* @param resource the resource for the jabber account
*/
public void setResource(String resource)
{
putAccountProperty(ProtocolProviderFactory.RESOURCE, resource);
}
/**
* Returns the priority property.
* @return priority
*/
public int getPriority()
{
return getAccountPropertyInt(
ProtocolProviderFactory.RESOURCE_PRIORITY, 30);
}
/**
* Sets the priority property.
* @param priority the priority to set
*/
public void setPriority(int priority)
{
putAccountProperty(
ProtocolProviderFactory.RESOURCE_PRIORITY, priority);
}
/**
* Indicates if ice should be used for this account.
* @return true if ICE should be used for this account, otherwise
* returns false
*/
public boolean isUseIce()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.IS_USE_ICE, true);
}
/**
* Sets the useIce property.
* @param isUseIce true to indicate that ICE should be used for
* this account, false - otherwise.
*/
public void setUseIce(boolean isUseIce)
{
putAccountProperty(ProtocolProviderFactory.IS_USE_ICE, isUseIce);
}
/**
* Indicates if the stun server should be automatically discovered.
* @return true if the stun server should be automatically
* discovered, otherwise returns false.
*/
public boolean isAutoDiscoverStun()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.AUTO_DISCOVER_STUN, true);
}
/**
* Sets the autoDiscoverStun property.
* @param isAutoDiscover true to indicate that stun server should
* be auto-discovered, false - otherwise.
*/
public void setAutoDiscoverStun(boolean isAutoDiscover)
{
putAccountProperty(
ProtocolProviderFactory.AUTO_DISCOVER_STUN, isAutoDiscover);
}
/**
* Sets the useDefaultStunServer property.
* @param isUseDefaultStunServer true to indicate that default
* stun server should be used if no others are available, false
* otherwise.
*/
public void setUseDefaultStunServer(boolean isUseDefaultStunServer)
{
putAccountProperty( ProtocolProviderFactory.USE_DEFAULT_STUN_SERVER,
isUseDefaultStunServer );
}
/**
* Sets the autoDiscoverJingleNodes property.
*
* @param isAutoDiscover true to indicate that relay server should
* be auto-discovered, false - otherwise.
*/
public void setAutoDiscoverJingleNodes(boolean isAutoDiscover)
{
putAccountProperty(
ProtocolProviderFactory.AUTO_DISCOVER_JINGLE_NODES,
isAutoDiscover );
}
/**
* Indicates if the JingleNodes relay server should be automatically
* discovered.
*
* @return true if the relay server should be automatically
* discovered, otherwise returns false.
*/
public boolean isAutoDiscoverJingleNodes()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.AUTO_DISCOVER_JINGLE_NODES, true);
}
/**
* Sets the useJingleNodes property.
*
* @param isUseJingleNodes true to indicate that Jingle Nodes
* should be used for this account, false - otherwise.
*/
public void setUseJingleNodes(boolean isUseJingleNodes)
{
putAccountProperty(
ProtocolProviderFactory.IS_USE_JINGLE_NODES, isUseJingleNodes);
}
/**
* Indicates if JingleNodes relay should be used.
*
* @return true if JingleNodes should be used, false
* otherwise
*/
public boolean isUseJingleNodes()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.IS_USE_JINGLE_NODES, true);
}
/**
* Indicates if UPnP should be used for this account.
* @return true if UPnP should be used for this account, otherwise
* returns false
*/
public boolean isUseUPNP()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.IS_USE_UPNP, true);
}
/**
* Sets the useUPNP property.
* @param isUseUPNP true to indicate that UPnP should be used for
* this account, false - otherwise.
*/
public void setUseUPNP(boolean isUseUPNP)
{
putAccountProperty(ProtocolProviderFactory.IS_USE_UPNP, isUseUPNP);
}
/**
* Indicates if non-TLS is allowed for this account
* @return true if non-TLS is allowed for this account, otherwise
* returns false
*/
public boolean isAllowNonSecure()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.IS_ALLOW_NON_SECURE, false);
}
/**
* Sets the isAllowNonSecure property.
* @param isAllowNonSecure true to indicate that non-TLS is allowed
* for this account, false - otherwise.
*/
public void setAllowNonSecure(boolean isAllowNonSecure)
{
putAccountProperty(
ProtocolProviderFactory.IS_ALLOW_NON_SECURE, isAllowNonSecure);
}
/**
* Indicates if message carbons are allowed for this account
* @return true if message carbons are allowed for this account,
* otherwise returns false
*/
public boolean isCarbonDisabled()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.IS_CARBON_DISABLED, false);
}
/**
* Sets the IS_CARBON_DISABLED property.
* @param isCarbonEnabled true to indicate that message carbons are
* allowed for this account, false - otherwise.
*/
public void setDisableCarbon(boolean isCarbonEnabled)
{
putAccountProperty(
ProtocolProviderFactory.IS_CARBON_DISABLED, isCarbonEnabled);
}
/**
* Is resource auto generate enabled.
*
* @return true if resource is auto generated
*/
public boolean isResourceAutogenerated()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.AUTO_GENERATE_RESOURCE, true );
}
/**
* Set whether resource autogenerate is enabled.
* @param resourceAutogenerated
*/
public void setResourceAutogenerated(boolean resourceAutogenerated)
{
putAccountProperty(
ProtocolProviderFactory.AUTO_GENERATE_RESOURCE,
resourceAutogenerated );
}
/**
* Returns the default sms server.
*
* @return the account default sms server
*/
public String getSmsServerAddress()
{
return getAccountPropertyString(
ProtocolProviderFactory.SMS_SERVER_ADDRESS);
}
/**
* Sets the default sms server.
*
* @param serverAddress the sms server to set as default
*/
public void setSmsServerAddress(String serverAddress)
{
setOrRemoveIfEmpty(
ProtocolProviderFactory.SMS_SERVER_ADDRESS, serverAddress);
}
/**
* Returns the service name - the server we are logging to
* if it is null which is not supposed to be - we return for compatibility
* the string we used in the first release for creating AccountID
* (Using this string is wrong, but used for compatibility for now)
* @param accountProperties Map
* @return String
*/
private static String getServiceName(Map accountProperties)
{
return accountProperties.get(ProtocolProviderFactory.SERVER_ADDRESS);
}
/**
* Returns the list of JingleNodes trackers/relays that this account is
* currently configured to use.
*
* @return the list of JingleNodes trackers/relays that this account is
* currently configured to use.
*/
public List getJingleNodes()
{
Map accountProperties = getAccountProperties();
List serList
= new ArrayList();
for (int i = 0; i < JingleNodeDescriptor.MAX_JN_RELAY_COUNT; i ++)
{
JingleNodeDescriptor node
= JingleNodeDescriptor.loadDescriptor(
accountProperties,
JingleNodeDescriptor.JN_PREFIX + i);
// If we don't find a relay server with the given index, it means
// that there're no more servers left in the table so we've nothing
// more to do here.
if (node == null)
break;
serList.add(node);
}
return serList;
}
/**
* Determines whether this account's provider is supposed to auto discover
* JingleNodes relay.
*
* @return true if this provider would need to discover JingleNodes
* relay, false otherwise
*/
public boolean isJingleNodesAutoDiscoveryEnabled()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.AUTO_DISCOVER_JINGLE_NODES,
true);
}
/**
* Determines whether this account's provider is supposed to auto discover
* JingleNodes relay by searching our contacts.
*
* @return true if this provider would need to discover JingleNodes
* relay by searching buddies, false otherwise
*/
public boolean isJingleNodesSearchBuddiesEnabled()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.JINGLE_NODES_SEARCH_BUDDIES,
false);
}
/**
* Determines whether this account's provider uses JingleNodes relay (if
* available).
*
* @return true if this provider would use JingleNodes relay (if
* available), false otherwise
*/
public boolean isJingleNodesRelayEnabled()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.IS_USE_JINGLE_NODES,
true);
}
/**
* Determines whether this account's provider allow non-secure connection
*
* @return true if this provider would allow non-secure connection,
* false otherwise
*/
public boolean allowNonSecureConnection()
{
return getAccountPropertyBoolean(
ProtocolProviderFactory.IS_ALLOW_NON_SECURE,
false);
}
/**
* {@inheritDoc}
*/
protected String getDefaultString(String key)
{
return JabberAccountID.getDefaultStr(key);
}
/**
* Gets default property value for given key.
*
* @param key the property key
* @return default property value for givenkey
*/
public static String getDefaultStr(String key)
{
String value = ProtocolProviderActivator
.getConfigurationService()
.getString(JBR_DEFAULTS_PREFIX +key);
if(value == null)
value = AccountID.getDefaultStr(key);
return value;
}
/**
* Gets default boolean property value for given key.
*
* @param key the property key
* @return default property value for givenkey
*/
public static boolean getDefaultBool(String key)
{
return Boolean.parseBoolean(getDefaultStr(key));
}
}