Oracle Application Server Wireless Java API Reference
B14043-01


oracle.panama.messaging.common
Class SyncOTASetting

java.lang.Object
  extended byjava.util.Dictionary
      extended byjava.util.Hashtable
          extended byoracle.panama.messaging.common.SyncOTASetting

All Implemented Interfaces:
java.lang.Cloneable, java.util.Map, java.io.Serializable

public class SyncOTASetting
extends java.util.Hashtable

This class can be used to create a syncML OTA Settings.

See Also:
Serialized Form

Field Summary
static java.lang.String ADDR
Key for address value of connection reference.
static java.lang.String ADDRTYPE
Key for address type value of the connection reference.
static java.lang.String ADDRTYPE_ALPHA
Defines generic alphanumeric Address Type.
static java.lang.String ADDRTYPE_APN
Defines Access Point Name Address Type.
static java.lang.String ADDRTYPE_E164
Defines Address Type as phone number according to E164 scheme.
static java.lang.String ADDRTYPE_IPV4
Defines IPv4 Address Type.
static java.lang.String ADDRTYPE_IPV6
Defines IPv6 Address Type.
static java.lang.String AUTH
Key for authentication procedures and credentials used in SyncML session.
static java.lang.String AUTHLEVEL
Key for authentication level.
static java.lang.String AUTHLEVEL_HTTPWSP
Defines HTTP level Authentication level.
static java.lang.String AUTHLEVEL_OBEX
Defines OBEX Authentication level.
static java.lang.String AUTHLEVEL_SYNCMLSERVER
Defines Authentication level used in the credentials in SyncHdr.
static java.lang.String AUTHSCHEME
Key for authentication scheme.
static java.lang.String AUTHSCHEME_BASIC
Defines basic authentication level.
static java.lang.String AUTHSCHEME_DIGEST
Defines MD5 authentication level.
static java.lang.String BEARER
Key for bearer type of the connection reference.
static java.lang.String BEARER_AMPS_CDPD
Defines AMPS CDPD bearer.
static java.lang.String BEARER_ANSI_136CSD
Defines ANSI 136 CSD bearer.
static java.lang.String BEARER_ANSI_136GHOST
Defines ANSI 136 GHOST bearer.
static java.lang.String BEARER_ANSI_136GUTS
Defines ANSI 136GUTS bearer.
static java.lang.String BEARER_ANSI_136PACKET
Defines ANSI 136 PACKET bearer.
static java.lang.String BEARER_FLEX
Defines FLEX bearer.
static java.lang.String BEARER_GSM_CSD
Defines GSM CSD bearer.
static java.lang.String BEARER_GSM_GPRS
Defines GSM GPRS bearer.
static java.lang.String BEARER_GSM_SMS
Defines GSM SMS bearer.
static java.lang.String BEARER_GSM_USSD
Defines GSM USSD bearer.
static java.lang.String BEARER_IDEN_CSD
Defines IDEN CSDbearer.
static java.lang.String BEARER_IDEN_PACKET
Defines IDEN PACKET bearer.
static java.lang.String BEARER_IDEN_SMS
Defines IDEN SMS bearer.
static java.lang.String BEARER_IS95_CDMACSD
Defines IS95 CDMA CSD bearer
static java.lang.String BEARER_IS95_CDMAPACKET
Defines IS95 CDMA PACKET bearer.
static java.lang.String BEARER_IS95_CDMASMS
Defines IS95 CMDA SMS bearer
static java.lang.String BEARER_MOBITEX_MPAK
Defines MOBITEX MPAK bearer.
static java.lang.String BEARER_OBEX
Defines OBEX bearer.
static java.lang.String BEARER_PDC_CSD
Defines PDC CSD bearer.
static java.lang.String BEARER_PDC_PACKET
Defines PDC PACKET bearer.
static java.lang.String BEARER_PHS_CSD
Defines PHS CSD bearer.
static java.lang.String BEARER_PHS_SMS
Defines PHS SMS bearer.
static java.lang.String BEARER_TETRA_PACKET
Defines TETRA PACKET bearer.
static java.lang.String BEARER_TETRA_SDS
Defines TETRA SDS bearer.
static java.lang.String CONREF
Key for reference to physical or logical access point used by SyncML settings.
static java.lang.String CONTENTDESC
Key for CONREF + CONTYPE.
static java.lang.String CONTYPE
Key for type of connection.
static java.lang.String CONTYPE_HTTPWAP2
Defines HTTP/WAP 2.x proxy
static java.lang.String CONTYPE_LOGICALAP
Defines Logical AP(Name by which access point have been grouped in the configuration) connection type.
static java.lang.String CONTYPE_PHYSICALAP
Defines Physical AP(Refers to real address: bearer, address type, address value) connection type.
static java.lang.String CONTYPE_WAP1
Defines WAP 1.x proxy connection type.
static java.lang.String CRED
Key for credential for authentication.
static java.lang.String CTTYPE
Key for supported media content type of the remote db.
static java.lang.String CTVER
Key for version of supported content type.
static java.lang.String HOSTADDR
Key for host address of the SyncML service.
static java.lang.String MIME
SyncML OTA Settins MIME type.
static java.lang.String NAME
Key for displayable name of the SyncML setting or remote db
static java.lang.String PHONE_MODEL
Key for phone model.
static java.lang.String PORT
Key for transport port of origin server.
static java.lang.String REFID
Key for logical reference value of the connection reference.
static java.lang.String REMOTEDB
Key for remote db and authentication information of the db.
static java.lang.String SYNCSETTINGS
Key for root element.
static java.lang.String URI
Key for relation or absolute URI of the remote db.
static java.lang.String USERNAME
Key for username
static java.lang.String VERSION
Key for version.
static java.lang.String VERSION_10
Defines WBXML verison 1.0
static java.lang.String VERSION_11
Defines WBXML version 1.1
static java.lang.String WBXML_VERSION
Key for wbxml verion.

Constructor Summary
SyncOTASetting()
Constructor.

Method Summary
boolean equals(java.lang.Object other)
Checks equality of two SyncOTASetting objects.
int hashCode()
Generates are return hashcode for the instance.
void setAuth(java.lang.String[][] auth)
This method sets the authentication procedure and credentials used in the SyncML session.
void setConRef(java.lang.String[][] conRef)
This method sets the reference to a physical or logical access point used by these SyncML settings.
void setHostAddr(java.lang.String address)
Sets hostaddress of the SyncML service(origin server).
void setName(java.lang.String name)
void setPhoneModel(java.lang.String model)
Set the phone model.
void setPort(java.lang.String port)
Sets the tranport port of the origin server(SyncML service).
void setRemoteDB(java.util.Vector contentDesc, java.lang.String uri, java.lang.String name, java.lang.String[][] auth)
Sets the remote database to be synchronised and the authentication information of the data base.
This method can be called multiple times with different set of parmaters to set more than one RemoteDB.
Content model ((CTTYPE, CTVER*)+, URI, NAME?, AUTH?)
void setVersion(java.lang.String version)
This method is used to set the version of the WBXML to be used while sending the syncml setting.

Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, get, isEmpty, keys, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Field Detail

ADDR

public static final java.lang.String ADDR
Key for address value of connection reference.
See Also:
Constant Field Values

ADDRTYPE

public static final java.lang.String ADDRTYPE
Key for address type value of the connection reference.
See Also:
Constant Field Values

ADDRTYPE_ALPHA

public static final java.lang.String ADDRTYPE_ALPHA
Defines generic alphanumeric Address Type.
See Also:
Constant Field Values

ADDRTYPE_APN

public static final java.lang.String ADDRTYPE_APN
Defines Access Point Name Address Type.
See Also:
Constant Field Values

ADDRTYPE_E164

public static final java.lang.String ADDRTYPE_E164
Defines Address Type as phone number according to E164 scheme.
See Also:
Constant Field Values

ADDRTYPE_IPV4

public static final java.lang.String ADDRTYPE_IPV4
Defines IPv4 Address Type.
See Also:
Constant Field Values

ADDRTYPE_IPV6

public static final java.lang.String ADDRTYPE_IPV6
Defines IPv6 Address Type.
See Also:
Constant Field Values

AUTH

public static final java.lang.String AUTH
Key for authentication procedures and credentials used in SyncML session.
See Also:
Constant Field Values

AUTHLEVEL

public static final java.lang.String AUTHLEVEL
Key for authentication level.
See Also:
Constant Field Values

AUTHLEVEL_HTTPWSP

public static final java.lang.String AUTHLEVEL_HTTPWSP
Defines HTTP level Authentication level.
See Also:
Constant Field Values

AUTHLEVEL_OBEX

public static final java.lang.String AUTHLEVEL_OBEX
Defines OBEX Authentication level.
See Also:
Constant Field Values

AUTHLEVEL_SYNCMLSERVER

public static final java.lang.String AUTHLEVEL_SYNCMLSERVER
Defines Authentication level used in the credentials in SyncHdr.
See Also:
Constant Field Values

AUTHSCHEME

public static final java.lang.String AUTHSCHEME
Key for authentication scheme.
See Also:
Constant Field Values

AUTHSCHEME_BASIC

public static final java.lang.String AUTHSCHEME_BASIC
Defines basic authentication level.
See Also:
Constant Field Values

AUTHSCHEME_DIGEST

public static final java.lang.String AUTHSCHEME_DIGEST
Defines MD5 authentication level.
See Also:
Constant Field Values

BEARER

public static final java.lang.String BEARER
Key for bearer type of the connection reference.
See Also:
Constant Field Values

BEARER_AMPS_CDPD

public static final java.lang.String BEARER_AMPS_CDPD
Defines AMPS CDPD bearer.
See Also:
Constant Field Values

BEARER_ANSI_136CSD

public static final java.lang.String BEARER_ANSI_136CSD
Defines ANSI 136 CSD bearer.
See Also:
Constant Field Values

BEARER_ANSI_136GHOST

public static final java.lang.String BEARER_ANSI_136GHOST
Defines ANSI 136 GHOST bearer.
See Also:
Constant Field Values

BEARER_ANSI_136GUTS

public static final java.lang.String BEARER_ANSI_136GUTS
Defines ANSI 136GUTS bearer.
See Also:
Constant Field Values

BEARER_ANSI_136PACKET

public static final java.lang.String BEARER_ANSI_136PACKET
Defines ANSI 136 PACKET bearer.
See Also:
Constant Field Values

BEARER_FLEX

public static final java.lang.String BEARER_FLEX
Defines FLEX bearer.
See Also:
Constant Field Values

BEARER_GSM_CSD

public static final java.lang.String BEARER_GSM_CSD
Defines GSM CSD bearer.
See Also:
Constant Field Values

BEARER_GSM_GPRS

public static final java.lang.String BEARER_GSM_GPRS
Defines GSM GPRS bearer.
See Also:
Constant Field Values

BEARER_GSM_SMS

public static final java.lang.String BEARER_GSM_SMS
Defines GSM SMS bearer.
See Also:
Constant Field Values

BEARER_GSM_USSD

public static final java.lang.String BEARER_GSM_USSD
Defines GSM USSD bearer.
See Also:
Constant Field Values

BEARER_IDEN_CSD

public static final java.lang.String BEARER_IDEN_CSD
Defines IDEN CSDbearer.
See Also:
Constant Field Values

BEARER_IDEN_PACKET

public static final java.lang.String BEARER_IDEN_PACKET
Defines IDEN PACKET bearer.
See Also:
Constant Field Values

BEARER_IDEN_SMS

public static final java.lang.String BEARER_IDEN_SMS
Defines IDEN SMS bearer.
See Also:
Constant Field Values

BEARER_IS95_CDMACSD

public static final java.lang.String BEARER_IS95_CDMACSD
Defines IS95 CDMA CSD bearer
See Also:
Constant Field Values

BEARER_IS95_CDMAPACKET

public static final java.lang.String BEARER_IS95_CDMAPACKET
Defines IS95 CDMA PACKET bearer.
See Also:
Constant Field Values

BEARER_IS95_CDMASMS

public static final java.lang.String BEARER_IS95_CDMASMS
Defines IS95 CMDA SMS bearer
See Also:
Constant Field Values

BEARER_MOBITEX_MPAK

public static final java.lang.String BEARER_MOBITEX_MPAK
Defines MOBITEX MPAK bearer.
See Also:
Constant Field Values

BEARER_OBEX

public static final java.lang.String BEARER_OBEX
Defines OBEX bearer.
See Also:
Constant Field Values

BEARER_PDC_CSD

public static final java.lang.String BEARER_PDC_CSD
Defines PDC CSD bearer.
See Also:
Constant Field Values

BEARER_PDC_PACKET

public static final java.lang.String BEARER_PDC_PACKET
Defines PDC PACKET bearer.
See Also:
Constant Field Values

BEARER_PHS_CSD

public static final java.lang.String BEARER_PHS_CSD
Defines PHS CSD bearer.
See Also:
Constant Field Values

BEARER_PHS_SMS

public static final java.lang.String BEARER_PHS_SMS
Defines PHS SMS bearer.
See Also:
Constant Field Values

BEARER_TETRA_PACKET

public static final java.lang.String BEARER_TETRA_PACKET
Defines TETRA PACKET bearer.
See Also:
Constant Field Values

BEARER_TETRA_SDS

public static final java.lang.String BEARER_TETRA_SDS
Defines TETRA SDS bearer.
See Also:
Constant Field Values

CONREF

public static final java.lang.String CONREF
Key for reference to physical or logical access point used by SyncML settings.
See Also:
Constant Field Values

CONTENTDESC

public static final java.lang.String CONTENTDESC
Key for CONREF + CONTYPE.
See Also:
Constant Field Values

CONTYPE

public static final java.lang.String CONTYPE
Key for type of connection.
See Also:
Constant Field Values

CONTYPE_HTTPWAP2

public static final java.lang.String CONTYPE_HTTPWAP2
Defines HTTP/WAP 2.x proxy
See Also:
Constant Field Values

CONTYPE_LOGICALAP

public static final java.lang.String CONTYPE_LOGICALAP
Defines Logical AP(Name by which access point have been grouped in the configuration) connection type.
See Also:
Constant Field Values

CONTYPE_PHYSICALAP

public static final java.lang.String CONTYPE_PHYSICALAP
Defines Physical AP(Refers to real address: bearer, address type, address value) connection type.
See Also:
Constant Field Values

CONTYPE_WAP1

public static final java.lang.String CONTYPE_WAP1
Defines WAP 1.x proxy connection type.
See Also:
Constant Field Values

CRED

public static final java.lang.String CRED
Key for credential for authentication.
See Also:
Constant Field Values

CTTYPE

public static final java.lang.String CTTYPE
Key for supported media content type of the remote db.
See Also:
Constant Field Values

CTVER

public static final java.lang.String CTVER
Key for version of supported content type.
See Also:
Constant Field Values

HOSTADDR

public static final java.lang.String HOSTADDR
Key for host address of the SyncML service.
See Also:
Constant Field Values

MIME

public static final java.lang.String MIME
SyncML OTA Settins MIME type.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
Key for displayable name of the SyncML setting or remote db
See Also:
Constant Field Values

PHONE_MODEL

public static final java.lang.String PHONE_MODEL
Key for phone model.
See Also:
Constant Field Values

PORT

public static final java.lang.String PORT
Key for transport port of origin server.
See Also:
Constant Field Values

REFID

public static final java.lang.String REFID
Key for logical reference value of the connection reference.
See Also:
Constant Field Values

REMOTEDB

public static final java.lang.String REMOTEDB
Key for remote db and authentication information of the db.
See Also:
Constant Field Values

SYNCSETTINGS

public static final java.lang.String SYNCSETTINGS
Key for root element.
See Also:
Constant Field Values

URI

public static final java.lang.String URI
Key for relation or absolute URI of the remote db.
See Also:
Constant Field Values

USERNAME

public static final java.lang.String USERNAME
Key for username
See Also:
Constant Field Values

VERSION

public static final java.lang.String VERSION
Key for version.
See Also:
Constant Field Values

VERSION_10

public static final java.lang.String VERSION_10
Defines WBXML verison 1.0
See Also:
Constant Field Values

VERSION_11

public static final java.lang.String VERSION_11
Defines WBXML version 1.1
See Also:
Constant Field Values

WBXML_VERSION

public static final java.lang.String WBXML_VERSION
Key for wbxml verion.
See Also:
Constant Field Values

Constructor Detail

SyncOTASetting

public SyncOTASetting()
Constructor. - sets the syncML client setting version to 1.0

Method Detail

equals

public boolean equals(java.lang.Object other)
Checks equality of two SyncOTASetting objects.
Parameters:
other - SyncOTASetting object to be tested for equality with this instance.
Returns:
true if the two instances are equal else returns false.

hashCode

public int hashCode()
Generates are return hashcode for the instance.
Returns:
hash code.

setAuth

public void setAuth(java.lang.String[][] auth)
This method sets the authentication procedure and credentials used in the SyncML session.

setConRef

public void setConRef(java.lang.String[][] conRef)
This method sets the reference to a physical or logical access point used by these SyncML settings.
Parameters:
conRef - is a two dimentional string array and each of its row contains a name value pair. Then names could be ConType, Bearer, AddrType, Addr, RefId.

setHostAddr

public void setHostAddr(java.lang.String address)
Sets hostaddress of the SyncML service(origin server). The TCP port number of origin server must not be defined. The maximum length should be 150 bytes.

setName

public void setName(java.lang.String name)
Parameters:
name - should contain the displayable name of the syncML settings. The maximum length of this paramter is 50 bytes.

setPhoneModel

public void setPhoneModel(java.lang.String model)
Set the phone model. The phone model should be of the format: "band type", for example: "Nokia 6210", "Ericsson T68i". It is case insensitive.

setPort

public void setPort(java.lang.String port)
Sets the tranport port of the origin server(SyncML service). Maximum length is 5 bytes.

setRemoteDB

public void setRemoteDB(java.util.Vector contentDesc,
                        java.lang.String uri,
                        java.lang.String name,
                        java.lang.String[][] auth)
Sets the remote database to be synchronised and the authentication information of the data base.
This method can be called multiple times with different set of parmaters to set more than one RemoteDB.
Content model ((CTTYPE, CTVER*)+, URI, NAME?, AUTH?)
  Eg: String[][] conDesc1 = {{syncSetting.CTTYPE,"text/x-vcard"},
                             {syncSetting.CTVER, "2.1"}};
     Vector cons1 = new Vector();
     cons1.add(conDesc1);
      String[][] rdauth = {{syncSetting.AUTHSCHEME, syncSetting.AUTHSCHEME_BASIC},
                        {syncSetting.USERNAME, "james"},
                        {syncSetting.CRED, "cHdk"}
                       };

   syncSetting.setRemoteDB(cons1, "./Contacts?CLASS&EQ;PRIVATE",
   "Private Contact DB", rdauth);
   String[][] conDesc2 = {{syncSetting.CTTYPE,"text/x-vcalendar"},
                          {syncSetting.CTVER, "1.0"}};

  Vector cons2 = new Vector();
  cons2.add(conDesc2);
  syncSetting.setRemoteDB(cons2, "./Calendar","Calendar DB", null);
  
Parameters:
contentDesc - vector should contain a list of double dimension String array.Each row of this double dimentation array is a name value pair.Name should be "CTType" and "CTVer" and value field should specify a value corrosponding to these names. CTVER value string can contain "/" to specify more than one version. CTType should specify the supported media content type of the remote db. CTVER should specify the version of the supported content type.
uri - should contain the relative or absolute URI of the databse. The maximum length of this parameter is 100 bytes.
name - should contain the displayable name of the remote database. The maximum length of this paramter is 50 bytes.
auth - is a double dimension string array and each row of this double dimentation array is a name value pair. The names could be AuthLevel, AuthScheme, Username and Cred.

setVersion

public void setVersion(java.lang.String version)
This method is used to set the version of the WBXML to be used while sending the syncml setting.
Parameters:
version - can be VERSION_10 (WBXML 1.0) or VERSION_11(WBXML 1.1)

Oracle Application Server Wireless Java API Reference
B14043-01


Copyright © 2004 Oracle Corporation. All Rights Reserved.