ie.ncl.wap.push
Class ServiceIndicator

java.lang.Object
  ie.ncl.wap.push.WSPRequest
      ie.ncl.wap.push.ServiceIndicator

public class ServiceIndicator
extends WSPRequest

A Service Indicator is used to send some text and a URL to a mobile phone for the purposes of notifying a user of service events. The user reads the text and will be prompted to retrieve the page/data as specified by the URL.

Each ServiceIndicator has an ID. If a Service Indicator is sent to a phone with the same ID as a previous one, the previous one will be replaced.

CacheOperations are supported by phones that are WAP 1.2 compliant (e.g. Ericsson T68)

Cache Operations are sent to mobile phones using the WAPPush object.

See Also:

WAPPush

Field Summary

Fields inherited from class ie.ncl.wap.push.WSPRequest

SECURITY_METHOD_NETWPIN, SECURITY_METHOD_USERNETWPIN, SECURITY_METHOD_USERPIN, SECURITY_METHOD_USERPINMAC

Constructor Summary

ServiceIndicator(java.lang.String message, java.net.URI uri)

ServiceIndicator(java.lang.String message, java.net.URI uri, java.util.Date creationDate, java.util.Date expiryDate)
Create a Service Indicator specifying the message displayed to the user, the URL of the data that can be retrieved, the creation and expiry date of this indicator.

ServiceIndicator(java.lang.String message, java.net.URL url)

ServiceIndicator(java.lang.String message, java.net.URL url, java.util.Date creationDate, java.util.Date expiryDate)

Method Summary

java.lang.String	getCreationDate() Get the Creation Date of the Service Indicator.
java.lang.String	getExpiryDate() Get the Expiry Date of the Service Indicator.
java.net.URL	getHref() Alias for getURL.
java.lang.String	getIndicatorId() Get the ID of the Service Indicator.
java.lang.String	getText() Get the Text of the Service Indicator.
java.net.URL	getURL() Get the URL of the Service Indicator.
java.lang.String	getVersion() Set the WAP Push version.
java.lang.String	getXml()
void	setIndicatorId(java.lang.String indicatorId) Set the ID of the Service Indicator.
void	setVersion(java.lang.String version) Set the WAP Push version.

Methods inherited from class ie.ncl.wap.push.WSPRequest

encode, encodeToSms, encodeToSms, encodeToSms, encodeToSms, entityEncode, generateMac, getAttributes, getContentType, getEncoding, getHeader, getHeaderNames, getNetworkPin, getTransactionID, getUserPin, main, setAttributes, setEncoding, setHeader, setNetworkPin, setTransactionID, setUserPin, toSmartMessage, toSmartMessage, toSmartMessage, toSmartMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceIndicator

public ServiceIndicator(java.lang.String message,
                        java.net.URI uri,
                        java.util.Date creationDate,
                        java.util.Date expiryDate)

Create a Service Indicator specifying the message displayed to the user, the URL of the data that can be retrieved, the creation and expiry date of this indicator. The ID is of the Service Indicator is the URL by default.

See Also:

setIndicatorId(java.lang.String)

ServiceIndicator

public ServiceIndicator(java.lang.String message,
                        java.net.URI uri)

ServiceIndicator

public ServiceIndicator(java.lang.String message,
                        java.net.URL url)

ServiceIndicator

public ServiceIndicator(java.lang.String message,
                        java.net.URL url,
                        java.util.Date creationDate,
                        java.util.Date expiryDate)

Method Detail

getVersion

public java.lang.String getVersion()

Set the WAP Push version. Should be "1.1" (the default) or "1.2"

See Also:

setVersion(java.lang.String)

setVersion

public void setVersion(java.lang.String version)

Set the WAP Push version. Should be "1.1" (the default) or "1.2"

See Also:

getVersion()

getXml

public java.lang.String getXml()

Specified by:

getXml in class WSPRequest

getURL

public java.net.URL getURL()
                    throws java.net.MalformedURLException

Get the URL of the Service Indicator.

Throws:

java.net.MalformedURLException

getHref

public java.net.URL getHref()
                     throws java.net.MalformedURLException

Alias for getURL.

Throws:

java.net.MalformedURLException

getIndicatorId

public java.lang.String getIndicatorId()

Get the ID of the Service Indicator. If the service ID is not set then the URL is used as the ID.

getCreationDate

public java.lang.String getCreationDate()

Get the Creation Date of the Service Indicator.

getExpiryDate

public java.lang.String getExpiryDate()

Get the Expiry Date of the Service Indicator.

getText

public java.lang.String getText()

Get the Text of the Service Indicator.

setIndicatorId

public void setIndicatorId(java.lang.String indicatorId)

Set the ID of the Service Indicator. If the service ID is not set then the URL is used as the ID.