Oracle Application Server Wireless Java API Reference
B10400-01

oracle.panama.messaging.xms
Class XMSConnection

java.lang.Object
  |
  +--oracle.panama.rt.common.AbstractConnection
        |
        +--oracle.panama.messaging.xms.XMSConnectionBase
              |
              +--oracle.panama.messaging.xms.XMSConnection
All Implemented Interfaces:
oracle.panama.rt.async.AsyncConnection, Request, RequestParameterNames, Response, oracle.panama.xhtml.XRequest, oracle.panama.xhtml.XResponse

public class XMSConnection
extends XMSConnectionBase
implements oracle.panama.rt.async.AsyncConnection

Field Summary

 

Fields inherited from interface oracle.panama.rt.async.AsyncConnection
META_SILENT_RESPONSE

 

Fields inherited from interface oracle.panama.rt.RequestParameterNames
BRAND_NAME, CALLBACK_LABEL, CALLBACK_URL, CHARACTER_ENCODING, CONNXN_ID, DEBUG, DEVICE_ID, EFFECTIVE_USER_NAME, FULL_CALLBACK_URL, GET_PAGE, GO_SESSION_HOME, LOCALE_PREFERENCE, LOGIN, LOGOFF, MODULE_STACK_SIZE, MS_XFORMER, PASSWORD, PATFOCUS, PATSELECTOR, REDIRECT, REFERER, REQUEST_LANDMARK, REQUEST_USER_PROFILE, SECTION, SERVICE_DESIGNER, SERVICE_OID, SERVICE_PATH, SESSION_HOME, SESSION_ID, SESSION_LANDMARK, SESSION_USER_PROFILE, SHORT_NAME, USER_NAME, VIRTUAL_URL, XFORMS_DOC_ID, XFORMS_EVENT_ID_PREFIX, XFORMS_RESERVED_PREFIX

 

Fields inherited from interface oracle.panama.xhtml.XResponse
MULTIMEDIA_AUDIO_TYPE, MULTIMEDIA_GRAMMAR_TYPE, MULTIMEDIA_IMAGE_TYPE, MULTIMEDIA_OTHER_TYPE, MULTIMEDIA_RINGTONE_TYPE, MULTIMEDIA_VIDEO_TYPE

 

Constructor Summary
XMSConnection(XMSController controller)
           

 

Method Summary
 java.lang.String cacheAndRewriteURL(oracle.panama.xhtml.view.AbstractViewRenderingContext context, org.w3c.dom.Element element, java.lang.String attrName, java.lang.String url)
          Hot spot for subclasses to rewrite the URLs in the output mark up page.
 oracle.panama.rt.async.AsyncSession getAsyncSession()
           
 java.net.URL getBaseURL()
           
 java.lang.String getContent(Device device)
          Get the response string rendered by the specified device transformer.
 XMSController getController()
           
 InputValueMap getInputValues()
           
 java.util.Locale getLocale()
          Get the encoding
 java.lang.String getParameter(java.lang.String key)
          Get the value of a parameter from the "Parameters" category
 java.lang.String getRemoteAddress()
          Get the IP address or other network address of the user agent.
 ServiceContext getServiceContext()
          Get the service context for the current request, current session, and requested service.
 java.lang.String getServiceHomeURL()
           
 boolean isNullResponse()
          check to see if a response should sent back to device
 void processScripletsAndURLs(org.w3c.dom.Node node)
          This method traverses the entire SimpleResult element and replaces all mobile scriplets with their correct values.
 void rewriteResultURLs(org.w3c.dom.Element el)
          Hot spot for subclasses to rewrite the URLs in the output mark up page.
 void setBaseURL(java.net.URL baseURL)
           
 void setContent(java.lang.String ml)
          Set the response string.
 void setInputValues(InputValueMap inputValues)
           
 void setLocale(java.util.Locale locale)
           
 void setNullResponseFlag(boolean flag)
          Set the flag to indicate there should be no response sent back to device
 void setRemoteAddress(java.lang.String remoteAddress)
           
 void setXMLContent(org.w3c.dom.Element element)
          Set the response data in XML document format.

 

Methods inherited from class oracle.panama.messaging.xms.XMSConnectionBase
execute, getArguments, getCharacterEncoding, getCurrentLocation, getHeaderAttributes, getHostingRuntime, getLocationMark, getMidTierURL, getRemoteAuthenticationType, getRemoteUser, getScheme, getServiceContextArguments, getServiceOid, getServiceParentURL, getServicePath, getUserCookies, getUserHomeURL, isRequestedSessionIdValid, isSecure, isValid, removeUserCookies, sendRedirect, setLocationMark, setUserCookies, validate, writeContent, writeContent

 

Methods inherited from class oracle.panama.rt.common.AbstractConnection
addRequestListener, addRequestListeners, addResponseListener, addResponseListeners, encodeURL, getAbstractController, getAddress, getApplicationParameter, getApplicationParameterMap, getApplicationParameterNames, getApplicationParameterValues, getAttribute, getAttributeNames, getAuthenticationType, getBinaryContent, getCarriers, getConnectionId, getConnUserInfo, getContent, getContentLength, getContentType, getDeliveryType, getDevice, getDeviceAddress, getDeviceId, getDocIdOfRenderableXformsDoc, getFileParameter, getFileParameterNames, getFileParameterValues, getJavaEncoding, getLocationAcquisitionTime, getMobileId, getModuleStackAction, getModuleVirtualURL, getParameterNames, getParameters, getParameterValues, getProcessingContext, getProcessingContextImpl, getProfile, getRequest, getRequestedSessionId, getResponse, getSection, getServiceId, getSession, getSessionEvent, getSessionImpl, getStyleAttribute, getSubscriberId, getTypeMismatchedTargets, getUserAgent, getUserDevice, getVirtualBrowserUserAgent, getXFormsDocument, getXFormsDocumentId, getXFormsParameters, getXhtmlDocumentURL, getXMLContent, hasXFormsFacetValidationError, invalidate, isAuthenticateUsingDeviceIdEnabled, isAutoLocated, isDebugOn, isProtocolSwitch, isProtocolSwitch, isSessionToBeTerminated, isVirtualUserEnabled, lookupRequest, notifyListeners, notifyListeners, popConnection, pushConnection, putOutstandingRequest, removeApplicationParameter, removeAttribute, removeFileParameter, removeOutstandingRequest, removeParameter, removeRequestListener, removeRequestListeners, removeResponseListener, removeResponseListeners, replaceSession, rewriteMobileScriplets, rewriteMultimediaURL, setAttribute, setAutoLocated, setConnectionId, setContent, setContent, setContentType, setDebugOn, setDevice, setDocIdOfRenderableXformsDoc, setFileParameter, setJavaEncoding, setLocationAcquisitionTime, setModuleStackAction, setModuleVirtualURL, setParameter, setParameterFast, setProcessingContextImpl, setProfile, setRequestedSessionId, setRequestEventMask, setResponseEventMask, setSection, setSenderAddress, setSessionEvent, setSessionImpl, setTypeMismatchedTargets, setUserAgent, setUserInput, setXFormsDocument, setXFormsDocumentId, setXFormsParameters, setXFormsParameters, terminateSession, writeErrorMessage, writeErrorMessage

 

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

 

Methods inherited from interface oracle.panama.rt.async.AsyncConnection
getDeliveryType, getDocIdOfRenderableXformsDoc, getServiceId, setDocIdOfRenderableXformsDoc

 

Methods inherited from interface oracle.panama.rt.Request
addRequestListener, addRequestListeners, execute, getArguments, getAttribute, getAttributeNames, getAuthenticationType, getCarriers, getCharacterEncoding, getCurrentLocation, getDevice, getDeviceAddress, getDeviceId, getFileParameter, getFileParameterNames, getFileParameterValues, getHeaderAttributes, getLocationAcquisitionTime, getLocationMark, getMobileId, getParameterNames, getParameterValues, getProfile, getRemoteAuthenticationType, getRemoteUser, getRequestedSessionId, getResponse, getScheme, getServiceOid, getServiceParentURL, getServicePath, getSession, getSubscriberId, getUserHomeURL, invalidate, isAutoLocated, isDebugOn, isRequestedSessionIdValid, isSecure, isValid, removeAttribute,  

Methods inherited from interface oracle.panama.rt.Response
addResponseListener, addResponseListeners, getCharacterEncoding, getContent, getXMLContent, removeResponseListener, removeResponseListeners, sendRedirect, setContent

 

Constructor Detail

XMSConnection

public XMSConnection(XMSController controller)
Method Detail

getServiceContext

public ServiceContext getServiceContext()
Description copied from interface: Request
Get the service context for the current request, current session, and requested service. A service context provides an API based on the XML document model for setting and transforming response data.
Specified by:
getServiceContext in interface Request
Returns:
a service context for current request, session, and service

getController

public XMSController getController()

processScripletsAndURLs

public void processScripletsAndURLs(org.w3c.dom.Node node)
                             throws PanamaException
This method traverses the entire SimpleResult element and replaces all mobile scriplets with their correct values. After that it calls rewriteResultURLs method for all elements in the SimpleResult to let the subclasses rewrite the URLs in protocol specific maner.
Overrides:
processScripletsAndURLs in class oracle.panama.rt.common.AbstractConnection
PanamaException

getBaseURL

public java.net.URL getBaseURL()
Returns:
service home url

setBaseURL

public void setBaseURL(java.net.URL baseURL)

setXMLContent

public void setXMLContent(org.w3c.dom.Element element)
Description copied from interface: Response
Set the response data in XML document format. Used to transfer data from one response object to another response object for nested or recursive service requests. XML documents are easier than Strings for merge and transformation.
Specified by:
setXMLContent in interface Response
Overrides:
setXMLContent in class oracle.panama.rt.common.AbstractConnection

getParameter

public java.lang.String getParameter(java.lang.String key)
Description copied from interface: Request
Get the value of a parameter from the "Parameters" category
Specified by:
getParameter in interface Request
Overrides:
getParameter in class oracle.panama.rt.common.AbstractConnection
Parameters:
key - name of the parameter
Returns:
value of the named parameter

getContent

public java.lang.String getContent(Device device)
                            throws java.lang.Exception
Get the response string rendered by the specified device transformer.
Specified by:
getContent in interface Response
Parameters:
device - the device to be rendered for
Returns:
the response string in some markup language
java.lang.Exception

rewriteResultURLs

public void rewriteResultURLs(org.w3c.dom.Element el)
                       throws PanamaException
Hot spot for subclasses to rewrite the URLs in the output mark up page.
Specified by:
rewriteResultURLs in class oracle.panama.rt.common.AbstractConnection
PanamaException

cacheAndRewriteURL

public java.lang.String cacheAndRewriteURL(oracle.panama.xhtml.view.AbstractViewRenderingContext context,
                                           org.w3c.dom.Element element,
                                           java.lang.String attrName,
                                           java.lang.String url)
Hot spot for subclasses to rewrite the URLs in the output mark up page.
Specified by:
cacheAndRewriteURL in class oracle.panama.rt.common.AbstractConnection
Parameters:
context - the XAnnotatorContext
element - the Element which contains the "href" attribute
attrName - the local name of the attribute which value (URL) is beign encoded
url - the absolute URL to the back-end data source
Returns:
String the iASW specific URL

setContent

public void setContent(java.lang.String ml)
Description copied from interface: Response
Set the response string. Used to transfer data from one response object to another response object for nested or recursive service requests.
Specified by:
setContent in interface Response
Overrides:
setContent in class oracle.panama.rt.common.AbstractConnection
Parameters:
ml - the response string in some markup language

getServiceHomeURL

public java.lang.String getServiceHomeURL()
Specified by:
getServiceHomeURL in interface Request
Returns:
service home url

setNullResponseFlag

public void setNullResponseFlag(boolean flag)
Set the flag to indicate there should be no response sent back to device
Specified by:
setNullResponseFlag in interface oracle.panama.rt.async.AsyncConnection
Parameters:
flag - No service response flag

isNullResponse

public boolean isNullResponse()
check to see if a response should sent back to device
Specified by:
isNullResponse in interface oracle.panama.rt.async.AsyncConnection
Returns:
True if no response should sent back

getLocale

public java.util.Locale getLocale()
Get the encoding
Specified by:
getLocale in interface oracle.panama.rt.async.AsyncConnection
Returns:
the encoding value

setLocale

public void setLocale(java.util.Locale locale)
Specified by:
setLocale in interface oracle.panama.rt.async.AsyncConnection

getRemoteAddress

public java.lang.String getRemoteAddress()
Get the IP address or other network address of the user agent. Returns "local" if the request is from an internal runtime agent.
Specified by:
getRemoteAddress in interface Request
Specified by:
getRemoteAddress in class oracle.panama.rt.common.AbstractConnection
Returns:
the network address of the user agent or runtime agent

setRemoteAddress

public void setRemoteAddress(java.lang.String remoteAddress)

getInputValues

public InputValueMap getInputValues()
Specified by:
getInputValues in interface oracle.panama.rt.async.AsyncConnection
Overrides:
getInputValues in class oracle.panama.rt.common.AbstractConnection

setInputValues

public void setInputValues(InputValueMap inputValues)

getAsyncSession

public oracle.panama.rt.async.AsyncSession getAsyncSession()
Specified by:
getAsyncSession in interface oracle.panama.rt.async.AsyncConnection

Oracle Application Server Wireless Java API Reference
B10400-01

Copyright © 2003 Oracle Corporation. All Rights Reserved.