com.objectxp.msg.ota
Class BrowserSettings

java.lang.Object
  com.objectxp.msg.Message
      com.objectxp.msg.SmsMessage
          com.objectxp.msg.ota.OTAMessage
              com.objectxp.msg.ota.BrowserSettings

All Implemented Interfaces:

MultiPartMessage, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ExtendedBrowserSettings, GsmSmsBrowserSettings, GsmUssdBrowserSettings

public abstract class BrowserSettings
extends OTAMessage

Browser Settings provide handsets with basic settings needed to establish a connection to be used for browsing. These settings may also include bookmarks.

This class cannot be used directly, instead use one of the classes below, depending on the bearer type.

• GsmCsdBrowserSettings
• GsmSmsBrowserSettings
• GsmUssdBrowserSettings
• Is136CsdBrowserSettings
• GPRSBrowserSettings

See Also:

Serialized Form

Field Summary

Fields inherited from class com.objectxp.msg.SmsMessage

CLASS_0, CLASS_1, CLASS_2, CLASS_3, DC_8BIT, DC_DEFAULT, DC_GROUP_DATA, DC_GROUP_GENERAL, DC_GROUP_MSG_WAITING_DISCARD, DC_GROUP_MSG_WAITING_STORE, DC_UCS2, INDICATION_ACTIVE, INDICATION_INACTIVE, INDICATION_TYPE_EMAIL, INDICATION_TYPE_FAX, INDICATION_TYPE_OTHER, INDICATION_TYPE_VOICEMAIL, NO_CLASS

Fields inherited from class com.objectxp.msg.Message

ACK_TIME, MT_BINARY, MT_STATUS, MT_TEXT, SENDER_TYPE_ALPHA, SENDER_TYPE_GUESS, SENDER_TYPE_NUMBER

Method Summary

void	addBookmark(Bookmark bookmark) Add a Bookmark to this Browser Settings.
java.util.Iterator	getBookmarks() Returns an Iterator over all Bookmarks.
java.lang.String	getBrowserSettingID() Returns the ID which has been set by setBrowserSettingID(String) or null if the ID is not set.
java.lang.String	getMMSURL() Returns the URL of the MMSC.
java.lang.String	getName() Get the user-recognisable name for te BrowserSettings.
int	getPort() Get the current port setting.
java.lang.String	getProxy() Returns the proxy address or null if unset.
boolean	removeBookmark(Bookmark bookmark) Remove a Bookmark from the Browser Settings.
void	setBrowserSettingID(java.lang.String id) Define an ID to be used to provide some security to the provisioning application.
void	setMMSURL(java.lang.String url) Specify the URL of the MMSC.
void	setName(java.lang.String name) Set the user-recognisable name for the BrowserSettings.
void	setPort(int port) Set the port number.
void	setProxy(java.lang.String address) Specify the address of the proxy.

Methods inherited from class com.objectxp.msg.ota.OTAMessage

buildParts, buildParts, getParts, toString

Methods inherited from class com.objectxp.msg.SmsMessage

containsUserDataHeader, copyFields, getAlphabet, getBytes, getCodingGroup, getDeferredDeliveryAsDate, getDeferredDeliveryInMinutes, getID, getIndicationState, getIndicationType, getMessage, getMessageClass, getParent, getPID, getRecipient, getRecipientAddress, getSender, getSenderAddress, getType, getUserData, getUserDataHeader, getValidityPeriodAsDate, getValidityPeriodInMinutes, hasDeferredDelivery, hasMessageClass, hasValidityPeriod, isCompressed, isMMS, isRejectDuplicates, isRelativeDeferredDelivery, isRelativeValidityPeriod, isReplyPath, requestStatusReport, requestStatusReport, setAlphabet, setCodingGroup, setCompression, setDeferredDelivery, setDeferredDelivery, setIndicationState, setIndicationType, setMessage, setMessage, setMessageClass, setMMS, setParent, setPID, setRecipient, setRecipientAddress, setRejectDuplicates, setReplyPath, setSender, setSenderAddress, setType, setUserData, setUserDataHeader, setUserDataHeader, setValidityPeriod, setValidityPeriod

Methods inherited from class com.objectxp.msg.Message

clone, getProperty, getSenderType, getTimestamp, setID, setProperty, setSenderType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

setProxy

public void setProxy(java.lang.String address)
              throws java.lang.IllegalArgumentException

Specify the address of the proxy.

• In case of CSD the address is the IP address of the WAP proxy.
• In case of SMS the address is the SMSC MSISDN number.
• In case of USSD the address can be either an IP address or an MSISDN number.
  This is indicated in GsmUssdBrowserSettings.setProxyIPV4(boolean).

Parameters:

address - the proxy address (max length: 21) or null to clear the proxy address.

Throws:

java.lang.IllegalArgumentException - if the address length exceeds 21 characters.

getProxy

public java.lang.String getProxy()

Returns the proxy address or null if unset.

setPort

public void setPort(int port)
             throws java.lang.IllegalArgumentException

Set the port number. This setting specifies whether connection-less or connection-oriented connections should be used.

• Use 9200 (or 9202) for connection less connections.
• Use 9201 (or 9203) for connection oriented connections.

Please note that port number 9202 and 9203 enable secure connections whereas port numbers 9200 and 9201 disable secure connections.

If no Port is specified, a default value of 9200 is assumed.

Parameters:

port - the port number, one of 9200,9201,9202,9203

Throws:

java.lang.IllegalArgumentException - if an illegal port value has been specified.

getPort

public int getPort()

Get the current port setting.

Returns:

the current port setting

addBookmark

public void addBookmark(Bookmark bookmark)

Add a Bookmark to this Browser Settings. The first bookmark added indicates the homepage for the browser settings.

Several bookmarks can be added to the Browser Settings. However, the maximum number of bookmarks accepted is manufacturer specific.

Parameters:

bookmark - the bookmark to add

getBookmarks

public java.util.Iterator getBookmarks()

Returns an Iterator over all Bookmarks.

removeBookmark

public boolean removeBookmark(Bookmark bookmark)

Remove a Bookmark from the Browser Settings. Removes the first occurrence of the argument from the list of Bookmarks.

Parameters:

bookmark - the Bookmark to remove

Returns:

true if the Bookmark was a component of this Browser Settings; false otherwise.

setBrowserSettingID

public void setBrowserSettingID(java.lang.String id)
                         throws java.lang.IllegalArgumentException

Define an ID to be used to provide some security to the provisioning application. The ID should be known by the subscriber through the subscription or through other communication with the operator. When provisioning data containing the ID is received, the user is able to verify the received ID with the ID previously received by other means from the operator.

Support for the ID is manufacturer specific.

Parameters:

id - the ID (max length: 8), use null to clear the ID.

Throws:

java.lang.IllegalArgumentException - if the length of the ID exceeds 8 characters.

getBrowserSettingID

public java.lang.String getBrowserSettingID()

Returns the ID which has been set by setBrowserSettingID(String) or null if the ID is not set.

setName

public void setName(java.lang.String name)
             throws java.lang.IllegalArgumentException

Set the user-recognisable name for the BrowserSettings.

Parameters:

name - the name (maximum length: 20) or null to clear the name

Throws:

java.lang.IllegalArgumentException - if the length of the name exceeds 20 characters.

getName

public java.lang.String getName()

Get the user-recognisable name for te BrowserSettings.

Returns:

the name or null if not set

setMMSURL

public void setMMSURL(java.lang.String url)
               throws java.lang.IllegalArgumentException

Specify the URL of the MMSC.

Parameters:

url - the MMSC URL (max length: 100) or null to clear the URL.

Throws:

java.lang.IllegalArgumentException - if the length of the URL exceeds 100 characters.

getMMSURL

public java.lang.String getMMSURL()

Returns the URL of the MMSC.

Returns:

the MMSC URL or null if unset.