oracle.panama.messaging.xms
Class XMSConnectionBase

java.lang.Object
  |
  +--oracle.panama.rt.common.AbstractConnection
        |
        +--oracle.panama.messaging.xms.XMSConnectionBase

All Implemented Interfaces:

Request, RequestParameterNames, Response, oracle.panama.xhtml.XRequest, oracle.panama.xhtml.XResponse

Direct Known Subclasses:

XMSConnection

public abstract class XMSConnectionBase

extends oracle.panama.rt.common.AbstractConnection

Field Summary

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

XMSConnectionBase(oracle.panama.rt.common.AbstractController controller)

Method Summary

Response	execute() Execute a newly created request.
Arguments	getArguments() Get the arguments containing all URL parameters and header attributes.
java.lang.String	getCharacterEncoding() Get the language and locale used for character encoding
Point	getCurrentLocation() Get the location of the user using one of the following sources, 1.
java.util.Enumeration	getHeaderAttributes() Get the enumeration of attributes obtained from http header or equivalent source.
oracle.panama.xhtml.xforms.HostingRuntime	getHostingRuntime()
LocationMark	getLocationMark() Get the landmark that identifies the location of the caller.
java.lang.String	getMidTierURL(oracle.panama.xhtml.view.AbstractViewRenderingContext context, oracle.xml.xforms.doc.XFormsAbstractElement source, oracle.xml.parser.v2.XMLElement target) Get the URL to the iASW server
java.lang.String	getRemoteAuthenticationType() Returns the name of the authentication scheme used to authenticate the user.
java.lang.String	getRemoteUser() Returns the name of the user making this request, if the user has been authenticated (say thru mod_sso), or null if the user has not been authenticated.
java.lang.String	getScheme() Get the scheme used for the request message.
Arguments	getServiceContextArguments() Get the input arguments from the service context.
long	getServiceOid() Get the value of "PAoid" parameter which specifies the object id of the requested service.
java.lang.String	getServiceParentURL()
java.lang.String	getServicePath() Get the value of "PAservicepath" which specifies the path of the requested service in the repository.
java.lang.String	getUserCookies() Hot spot for subclasses to get cookies from user agents.
java.lang.String	getUserHomeURL()
boolean	isRequestedSessionIdValid() Test if the requested session id is valid.
boolean	isSecure() Verify whether the request is transmitted over a secure channel such HTTPS or SSL.
boolean	isValid() Test if the user is authenticated and session has been established.
void	removeUserCookies() Hot spot for subclasses to revive cookies from user agents.
void	sendRedirect(java.lang.String location) Send a URL to redirect the user agent or runtime agent to another location.
void	setLocationMark(LocationMark landmark) Set the landmark that identifies the location of the caller.
void	setUserCookies(oracle.panama.rt.util.UserInfo userInfo) Hot spot for subclasses to set cookies in user agents.
ServiceContext	validate() Validate the request by authenticating the user and authorizing the service.
void	writeContent() Hot spot for subclasses to return the output mark up page.
void	writeContent(java.lang.String content) Hot spot for subclasses to return the output mark up page.

Methods inherited from class oracle.panama.rt.common.AbstractConnection

addRequestListener, addRequestListeners, addResponseListener, addResponseListeners, cacheAndRewriteURL, 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, getInputValues, getJavaEncoding, getLocationAcquisitionTime, getMobileId, getModuleStackAction, getModuleVirtualURL, getParameter, getParameterNames, getParameters, getParameterValues, getProcessingContext, getProcessingContextImpl, getProfile, getRemoteAddress, 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, processScripletsAndURLs, pushConnection, putOutstandingRequest, removeApplicationParameter, removeAttribute, removeFileParameter, removeOutstandingRequest, removeParameter, removeRequestListener, removeRequestListeners, removeResponseListener, removeResponseListeners, replaceSession, rewriteMobileScriplets, rewriteMultimediaURL, rewriteResultURLs, setAttribute, setAutoLocated, setConnectionId, setContent, 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, setXMLContent, 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.Request

getServiceContext, getServiceHomeURL

Methods inherited from interface oracle.panama.rt.Response

getContent

Constructor Detail

XMSConnectionBase

public XMSConnectionBase(oracle.panama.rt.common.AbstractController controller)

Method Detail

execute

public Response execute()
                 throws PanamaException

Execute a newly created request. It applies the business logics such as authentication and authorization if necassary before invoking the service.

Specified by:

execute in interface Request

Specified by:

execute in class oracle.panama.rt.common.AbstractConnection

Returns:

the response that contains data from the invoked service

Throws:

PanamaException - if authentication or authorization fails

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Get the language and locale used for character encoding

Specified by:

getCharacterEncoding in interface Request

Specified by:

getCharacterEncoding in class oracle.panama.rt.common.AbstractConnection

Returns:

a string value like ISO-8859-n

getScheme

public java.lang.String getScheme()

Get the scheme used for the request message. For device user agents, possible values of schema are "http", "https", or "ftp". For runtime agent or recursive invocation, the schema is "internal".

Specified by:

getScheme in interface Request

Specified by:

getScheme in class oracle.panama.rt.common.AbstractConnection

Returns:

the name of the schema used for request messaging

isSecure

public boolean isSecure()

Verify whether the request is transmitted over a secure channel such HTTPS or SSL.

Specified by:

isSecure in interface Request

Specified by:

isSecure in class oracle.panama.rt.common.AbstractConnection

Returns:

true if the messaging channel is secure

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Test if the requested session id is valid. Session id is valid if the user session has not expired.

Specified by:

isRequestedSessionIdValid in interface Request

Specified by:

isRequestedSessionIdValid in class oracle.panama.rt.common.AbstractConnection

Returns:

true if the session id is still valid

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

Send a URL to redirect the user agent or runtime agent to another location. The behavior is subclass specific.

Specified by:

sendRedirect in interface Response

Specified by:

sendRedirect in class oracle.panama.rt.common.AbstractConnection

Parameters:

location - the URL for the new target

java.io.IOException

writeContent

public void writeContent(java.lang.String content)
                  throws PanamaException

Hot spot for subclasses to return the output mark up page.

Specified by:

writeContent in class oracle.panama.rt.common.AbstractConnection

PanamaException

writeContent

public void writeContent()
                  throws PanamaException

Hot spot for subclasses to return the output mark up page.

Specified by:

writeContent in class oracle.panama.rt.common.AbstractConnection

PanamaException

setUserCookies

public void setUserCookies(oracle.panama.rt.util.UserInfo userInfo)

Hot spot for subclasses to set cookies in user agents.

Specified by:

setUserCookies in class oracle.panama.rt.common.AbstractConnection

getUserCookies

public java.lang.String getUserCookies()

Hot spot for subclasses to get cookies from user agents.

Specified by:

getUserCookies in class oracle.panama.rt.common.AbstractConnection

removeUserCookies

public void removeUserCookies()

Hot spot for subclasses to revive cookies from user agents.

Specified by:

removeUserCookies in class oracle.panama.rt.common.AbstractConnection

getHeaderAttributes

public java.util.Enumeration getHeaderAttributes()

Get the enumeration of attributes obtained from http header or equivalent source.

Specified by:

getHeaderAttributes in interface Request

Specified by:

getHeaderAttributes in class oracle.panama.rt.common.AbstractConnection

getServiceContextArguments

public Arguments getServiceContextArguments()

Get the input arguments from the service context. This is more inclusive that getArguments().

Specified by:

getServiceContextArguments in class oracle.panama.rt.common.AbstractConnection

Returns:

the composite object containing input arguments

getRemoteUser

public java.lang.String getRemoteUser()

Returns the name of the user making this request, if the user has been authenticated (say thru mod_sso), or null if the user has not been authenticated.

Returns:

the name of the user making this request or null

getRemoteAuthenticationType

public java.lang.String getRemoteAuthenticationType()

Returns the name of the authentication scheme used to authenticate the user.

Returns:

the name of the authentication scheme

isValid

public boolean isValid()

Test if the user is authenticated and session has been established.

Returns:

true if the user is authenticated and service is authorized

getServiceOid

public long getServiceOid()
                   throws PanamaException

Get the value of "PAoid" parameter which specifies the object id of the requested service.

Returns:

the unique object id of the requested service

PanamaException

getServicePath

public java.lang.String getServicePath()

Get the value of "PAservicepath" which specifies the path of the requested service in the repository.

Returns:

the absolute path of the requested service in the repository

getArguments

public Arguments getArguments()
                       throws PanamaException

Get the arguments containing all URL parameters and header attributes. return the input arguments

PanamaException

validate

public ServiceContext validate()
                        throws PanamaException

Validate the request by authenticating the user and authorizing the service.

Returns:

the service context if the validation succeeds

PanamaException

setLocationMark

public void setLocationMark(LocationMark landmark)

Set the landmark that identifies the location of the caller. End-users may specify their location by selecting from a list of predefined land marks.

Specified by:

setLocationMark in interface Request

Overrides:

setLocationMark in class oracle.panama.rt.common.AbstractConnection

Parameters:

landmark - the landmark that identifies the location of the caller

getLocationMark

public LocationMark getLocationMark()

Get the landmark that identifies the location of the caller. End-users may specify their location by selecting from a list of predefined location marks.

Specified by:

getLocationMark in interface Request

Overrides:

getLocationMark in class oracle.panama.rt.common.AbstractConnection

Returns:

the landmark that identifies the location of the caller

getCurrentLocation

public Point getCurrentLocation()
                         throws CallerLocationException

Get the location of the user using one of the following sources, 1. from automatic location tracking module 2. from current landmark specified by user 3. or from the default landmark in the user profile

Specified by:

getCurrentLocation in interface Request

Overrides:

getCurrentLocation in class oracle.panama.rt.common.AbstractConnection

Returns:

the location of the user

Throws:

CallerLocationException

getUserHomeURL

public java.lang.String getUserHomeURL()

Returns:

the user's home deck url

getServiceParentURL

public java.lang.String getServiceParentURL()

Returns:

the containing folder url

getHostingRuntime

public oracle.panama.xhtml.xforms.HostingRuntime getHostingRuntime()

Specified by:

getHostingRuntime in class oracle.panama.rt.common.AbstractConnection

getMidTierURL

public java.lang.String getMidTierURL(oracle.panama.xhtml.view.AbstractViewRenderingContext context,
                                      oracle.xml.xforms.doc.XFormsAbstractElement source,
                                      oracle.xml.parser.v2.XMLElement target)

Get the URL to the iASW server

Parameters:

context - the XAnnotatorContext

source - the Element which contains the "href" attribute

target - the Element which contains the "href" attribute

Returns:

String the iASW specific URL