|
Oracle Application Server Wireless Java API Reference B10400-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents the request objects in PTG Runtime.
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 |
Method Summary | |
void |
addRequestListener(RequestListener listener) Add a listener for events from this request. |
void |
addRequestListeners(java.util.Vector listeners) Add a collection of listeners for events from request object. |
Response |
execute() Execute a newly created request. |
Arguments |
getArguments() Get the arguments containing all URL parameters and header attributes. |
java.lang.Object |
getAttribute(AttributeCategory category, java.lang.String name) Get the value of the named attribute in the chosen category |
java.util.Enumeration |
getAttributeNames(AttributeCategory category) Get an enumeration of all attribute names in a given category |
java.lang.String |
getAuthenticationType() Get the type of authentication used to identify the user. |
java.lang.String[] |
getCarriers() |
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. |
Device |
getDevice() Get the device model derived from the user agent type. |
DeviceAddress |
getDeviceAddress() |
java.lang.String |
getDeviceId() Get the device id, |
FileParameter |
getFileParameter(java.lang.String paramName) Get the value of a parameter from the "FileParameters" category |
java.util.Enumeration |
getFileParameterNames() Get the names of all file parameters |
FileParameter[] |
getFileParameterValues(java.lang.String paramName) Get the values of a parameter from the "FileParameters" category |
java.util.Enumeration |
getHeaderAttributes() Get the enumeration of attributes obtained from http header or equivalent source. |
java.util.Date |
getLocationAcquisitionTime() Get the time when the user location was acquired |
LocationMark |
getLocationMark() Get the landmark that identifies the location of the caller. |
java.lang.String |
getMobileId() Get the mobile id, which can be used for automatic location acquisition. |
java.lang.String |
getParameter(java.lang.String paramName) Get the value of a parameter from the "Parameters" category |
java.util.Enumeration |
getParameterNames() Get the names of all parameters |
java.lang.String[] |
getParameterValues(java.lang.String paramName) Get the values of a parameter from the "Parameters" category |
Profile |
getProfile() Get the user profile. |
java.lang.String |
getRemoteAddress() Get the IP address or other network address of the user agent. |
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 |
getRequestedSessionId() Get the session id contained in the request. |
Response |
getResponse() Get the Response interface associated with this request. |
java.lang.String |
getScheme() Get the schema used for the request message. |
ServiceContext |
getServiceContext() Get the service context for the current request, current session, and requested service. |
java.lang.String |
getServiceHomeURL() |
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. |
Session |
getSession() Get the session associated with the current request. |
java.lang.String |
getSubscriberId() Deprecated. use getMobileId instead |
java.lang.String |
getUserHomeURL() |
void |
invalidate() Invalidate the request and the associated service context and response objects. |
boolean |
isAutoLocated() Get the auto located (boolean) value. |
boolean |
isDebugOn() Test whether logging of debug information is requested. |
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 |
removeAttribute(AttributeCategory category, java.lang.String name) Remove the named attribute from the given category |
void |
removeFileParameter(java.lang.String paramName) Remove the parameter from the "FileParameters" category |
void |
removeParameter(java.lang.String paramName) Remove the parameter from the "Parameters" category |
void |
removeRequestListener(RequestListener listener) Remove a listener for events from this request. |
void |
removeRequestListeners(java.util.Vector listeners) Remove a collection of listeners for events from request object. |
void |
setAttribute(AttributeCategory category, java.lang.String name, java.lang.Object value) Set the value of the named attribute in the chosen category |
void |
setAutoLocated(boolean autoLocated) Set the auto located (boolean) parameter. |
void |
setDebugOn(boolean value) Set the flag to request logging of debug information for the current request. |
void |
setFileParameter(java.lang.String paramName, FileParameter paramValue) Set the value of a named parameter in the "FileParameters" category |
void |
setLocationMark(LocationMark landmark) Set the landmark that identifies the location of the caller. |
void |
setParameter(java.lang.String paramName, java.lang.String paramValue) Set the value of a named parameter in the "Parameters" category |
void |
setProfile(Profile profile) Set the user profile. |
void |
setSenderAddress(DeliveryType deliveryType, java.lang.String address, java.lang.String[] carrierInfo) Sets the address of the sender |
void |
setUserAgent(java.lang.String userAgent) Set the type of the user agent. |
void |
terminateSession() Terminate the user's session and return a logon page. |
ServiceContext |
validate() Validate the request by authenticating the user and authorizing the service. |
Method Detail |
public java.lang.Object getAttribute(AttributeCategory category, java.lang.String name)
category
- the attribute categoryname
- the name of the attributepublic void setAttribute(AttributeCategory category, java.lang.String name, java.lang.Object value)
category
- the attribute categoryname
- the name of the attributevalue
- the value for named attributepublic java.util.Enumeration getAttributeNames(AttributeCategory category)
category
- the attribute categorypublic void removeAttribute(AttributeCategory category, java.lang.String name)
category
- the attribute categoryname
- the name of the attributepublic java.util.Enumeration getParameterNames()
public java.lang.String getParameter(java.lang.String paramName)
paramName
- name of the parameterpublic java.lang.String[] getParameterValues(java.lang.String paramName)
paramName
- name of the parameterpublic void setParameter(java.lang.String paramName, java.lang.String paramValue)
paramName
- name of the parameterparamValue
- value of the parameterpublic void removeParameter(java.lang.String paramName)
paramName
- name of the parameterpublic java.util.Enumeration getFileParameterNames()
public FileParameter getFileParameter(java.lang.String paramName)
paramName
- name of the parameterpublic FileParameter[] getFileParameterValues(java.lang.String paramName)
paramName
- name of the parameterpublic void setFileParameter(java.lang.String paramName, FileParameter paramValue)
paramName
- name of the parameterparamValue
- value of the parameterpublic void removeFileParameter(java.lang.String paramName)
paramName
- name of the parameterpublic java.lang.String getCharacterEncoding()
public java.lang.String getScheme()
public java.lang.String getRemoteAddress()
public boolean isSecure()
public java.lang.String getAuthenticationType()
AuthenticationContext
public java.lang.String getRemoteUser()
public java.lang.String getRemoteAuthenticationType()
public java.lang.String getRequestedSessionId()
public boolean isRequestedSessionIdValid()
public boolean isValid()
public Session getSession()
public ServiceContext getServiceContext()
public Device getDevice()
public long getServiceOid() throws PanamaException
PanamaException
public java.lang.String getServicePath()
public void setUserAgent(java.lang.String userAgent)
userAgent
- the type of the user-agentDeviceIdentificationHook
public Arguments getArguments() throws PanamaException
PanamaException
public Response execute() throws PanamaException
PanamaException
public ServiceContext validate() throws PanamaException
PanamaException
public void invalidate()
public boolean isDebugOn()
public void setDebugOn(boolean value)
value
- true to select debug loggingpublic void addRequestListener(RequestListener listener)
public void removeRequestListener(RequestListener listener)
public void addRequestListeners(java.util.Vector listeners)
public void removeRequestListeners(java.util.Vector listeners)
public void setLocationMark(LocationMark landmark)
landmark
- the landmark that identifies the location of the callerpublic LocationMark getLocationMark()
public Point getCurrentLocation() throws CallerLocationException
CallerLocationException
public java.util.Date getLocationAcquisitionTime()
public boolean isAutoLocated()
setAutoLocated(boolean)
public void setAutoLocated(boolean autoLocated)
autoLocated
- the new value for the boolean parameterisAutoLocated()
public java.util.Enumeration getHeaderAttributes()
public java.lang.String getDeviceId()
public java.lang.String getMobileId()
public java.lang.String getSubscriberId()
public void terminateSession()
public Profile getProfile()
public void setProfile(Profile profile)
public void setSenderAddress(DeliveryType deliveryType, java.lang.String address, java.lang.String[] carrierInfo)
deliveryType
- the delivery typeaddress
- the address of the sendercarrierInfo
- delivery type specific parameters. For example, imap/pop server address for EMAIL delivery typepublic DeviceAddress getDeviceAddress()
public java.lang.String[] getCarriers()
public java.lang.String getUserHomeURL()
public java.lang.String getServiceHomeURL()
public java.lang.String getServiceParentURL()
public Response getResponse()
|
Oracle Application Server Wireless Java API Reference B10400-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |