|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents the session objects in Runtime.
Field Summary |
Fields inherited from interface oracle.panama.rt.SessionParameterNames |
COOKIES, USER_NAME, USER_REF |
Method Summary | |
void |
addSessionListener(SessionListener listener) Add a listener for events from this session. |
void |
addSessionListeners(java.util.Vector listeners) Add a collection of listeners for events from session object. |
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 |
User |
getAuthenticatedUser() Get the authenticated user who established the session. |
User |
getCreatingUser() Get the user (authenticated or virtual) who established the session. |
long |
getCreationTime() Get the creation time of the session. |
Point |
getCurrentLocation() Get the location of the user using one of the following sources, 1. |
java.lang.String |
getDeviceId() Get the device id, which can be used for identifying device |
User |
getEffectiveUser() Deprecated. use getUser instead |
Service |
getHomeService() Get the home service for this session. |
long |
getHomeServiceId() Get the user home service object id for this session. |
java.lang.String |
getId() Get the unique string identifier for the session. |
long |
getLastAccessedTime() Get the last access time of the session. |
java.util.Locale |
getLocale() Returns the locale of the session. |
LocationMark |
getLocationMark() Get the LocationMark that identifies the location of the caller. |
ManagedContext |
getManagedContext(java.lang.String key) Get the managed context for a given key. |
java.lang.String |
getMobileId() Get the mobile id, which can be used for automatic location acquisition. |
java.lang.String |
getNewManagedContextKey() Get a new key for a context to be managed. |
java.lang.String |
getParameter(java.lang.String paramName) Get the value of a parameter from the "Parameters" category |
Profile |
getProfile() Get the user profile. |
SessionHolder |
getSessionHolder() Get the session holder object that can be put in the HttpSession. |
java.lang.String |
getSubscriberId() Deprecated. use getMobileId instead |
User |
getUser() Get the effective user or authenticated user. |
void |
invalidate() Invalidate the session. |
boolean |
isAutoLocated() Get the auto located (boolean) value. |
boolean |
isInvalidated() Indicated whether the invalidate method has already been called |
boolean |
isUserAuthenticated() Check whether the user has been authenticated. |
void |
removeAttribute(AttributeCategory category, java.lang.String name) Remove the named attribute from the given category |
void |
removeParameter(java.lang.String paramName) Remove the parameter from the "Parameters" category |
void |
removeSessionListener(SessionListener listener) Remove a listener for events from this session. |
void |
removeSessionListeners(java.util.Vector listeners) Remove a collection of listeners for events from session 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 |
setEffectiveUser(User user) Set the effective user to be administered by the logged-in user. |
void |
setHomeServiceId(long id) Set the user home service object id for this session. |
void |
setLocationMark(LocationMark landmark) Set the LocationMark that identifies the location of the caller. |
void |
setManagedContext(java.lang.String key, ManagedContext context) Set the managed context for a given key. |
void |
setMaxInactiveInterval(long interval) Set the maximum inactive interval for a session. |
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. |
Method Detail |
public void addSessionListener(SessionListener listener)
public void addSessionListeners(java.util.Vector listeners)
public java.lang.Object getAttribute(AttributeCategory category, java.lang.String name)
category
- the attribute categoryname
- the name of the attributepublic java.util.Enumeration getAttributeNames(AttributeCategory category)
category
- the attribute categorypublic User getAuthenticatedUser()
public User getCreatingUser()
public long getCreationTime()
public Point getCurrentLocation() throws CallerLocationException
CallerLocationException
public java.lang.String getDeviceId()
public User getEffectiveUser()
public Service getHomeService()
getHomeServiceId()
, setHomeServiceId(long)
public long getHomeServiceId()
getHomeService()
, setHomeServiceId(long)
public java.lang.String getId()
public long getLastAccessedTime()
public java.util.Locale getLocale()
public LocationMark getLocationMark()
public ManagedContext getManagedContext(java.lang.String key)
key
- the unique key of a managed contextpublic java.lang.String getMobileId()
public java.lang.String getNewManagedContextKey()
public java.lang.String getParameter(java.lang.String paramName)
paramName
- name of the parameterpublic Profile getProfile()
public SessionHolder getSessionHolder()
public java.lang.String getSubscriberId()
public User getUser()
public void invalidate()
java.lang.IllegalStateException
- if this method is called on an already invalidated sessionAdapterContext
public boolean isAutoLocated()
setAutoLocated(boolean)
public boolean isInvalidated()
invalidate
method has already been calledinvalidate()
public boolean isUserAuthenticated()
public void removeAttribute(AttributeCategory category, java.lang.String name)
category
- the attribute categoryname
- the name of the attributepublic void removeParameter(java.lang.String paramName)
paramName
- name of the parameterpublic void removeSessionListener(SessionListener listener)
public void removeSessionListeners(java.util.Vector listeners)
public 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 void setAutoLocated(boolean autoLocated)
autoLocated
- the new value for the boolean parameterisAutoLocated()
public void setEffectiveUser(User user) throws UnauthorizedOperationException
UnauthorizedOperationException
public void setHomeServiceId(long id)
id
- the home service idgetHomeService()
, getHomeServiceId()
public void setLocationMark(LocationMark landmark)
public void setManagedContext(java.lang.String key, ManagedContext context)
key
- the unique of the managed contextcontext
- the context to be managedpublic void setMaxInactiveInterval(long interval)
interval
- the max. idle interval for time-to-livepublic void setParameter(java.lang.String paramName, java.lang.String paramValue)
paramName
- name of the parameterparamValue
- value of the parameterpublic void setProfile(Profile profile)
|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |