com.sapportals.wcm.repository

Class ResourceContext

java.lang.Object
  com.sapportals.wcm.repository.ResourceContext

All Implemented Interfaces:

IResourceContext, Serializable

public class ResourceContext

extends Object

implements IResourceContext, Serializable

Instances of this class contain information about the context the client is running is (request, session, etc.)

Copyright (c) SAP AG 2001-2004

See Also:

Serialized Form

Field Summary

protected Locale	locale the locale object
protected HashMap	properties some properties used by setValue() /getValue()
protected com.sapportals.portal.security.usermanagement.IUser	user the current user in that context

Fields inherited from interface com.sapportals.wcm.repository.IResourceContext

NO_KEYWORD_SUBSTITUTION

Constructor Summary

ResourceContext(com.sapportals.portal.security.usermanagement.IUser user)

ResourceContext(com.sapportals.portal.security.usermanagement.IUser user, Locale fallbackLocale)

ResourceContext(com.sapportals.portal.security.usermanagement.IUser user, Locale locale, boolean isPrimaryLocale)

Method Summary

IResourceContext	cloneContext() Clone resource context.
long	getCreationTime()
Locale	getLocale() Get the locale for that context.
Object	getObjectValue(String name) Returns the value for the specified name
com.sapportals.portal.security.usermanagement.IUser	getUser() Get the current user for that context.
String	getValue(String name) Returns the value for the specified name
HashMap	getValues() Returns the internal properties map as is without copying them to be used and possible modified from outside.
void	setLocale(Locale locale) Set the locale for that context.
void	setObjectValue(String name, Object value) Add/update a name/value pair
void	setUser(com.sapportals.portal.security.usermanagement.IUser user) Set the current user for that context.
void	setValue(String name, String value) Add/update a name/value pair
void	setValues(HashMap properties) Takes and sets the properties as is without copying them to be used and possibly modified as internal properties map.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

properties

protected HashMap properties

some properties used by setValue() /getValue()

locale

protected Locale locale

the locale object

user

protected transient com.sapportals.portal.security.usermanagement.IUser user

the current user in that context

Constructor Detail

ResourceContext

public ResourceContext(com.sapportals.portal.security.usermanagement.IUser user)

ResourceContext

public ResourceContext(com.sapportals.portal.security.usermanagement.IUser user,
                       Locale fallbackLocale)

ResourceContext

public ResourceContext(com.sapportals.portal.security.usermanagement.IUser user,
                       Locale locale,
                       boolean isPrimaryLocale)

Method Detail

getCreationTime

public long getCreationTime()

setObjectValue

public void setObjectValue(String name,
                           Object value)
                    throws ResourceException

Description copied from interface: IResourceContext

Add/update a name/value pair

Specified by:

setObjectValue in interface IResourceContext

Parameters:

name - A unique name

value - An object

Throws:

ResourceException - If the name paramater is invalid

getObjectValue

public Object getObjectValue(String name)

Description copied from interface: IResourceContext

Returns the value for the specified name

Specified by:

getObjectValue in interface IResourceContext

Parameters:

name - TBD: Description of the incoming method parameter

Returns:

The result object or null if the name was not found

setValue

public void setValue(String name,
                     String value)
              throws ResourceException

Description copied from interface: IResourceContext

Add/update a name/value pair

Specified by:

setValue in interface IResourceContext

Parameters:

name - A unique name

value - The value

Throws:

ResourceException - If the name paramater is invalid

getValue

public String getValue(String name)

Description copied from interface: IResourceContext

Returns the value for the specified name

Specified by:

getValue in interface IResourceContext

Parameters:

name - TBD: Description of the incoming method parameter

Returns:

The value or null if the name was not found

setValues

public void setValues(HashMap properties)

Description copied from interface: IResourceContext

Takes and sets the properties as is without copying them to be used and possibly modified as internal properties map.

Specified by:

setValues in interface IResourceContext

Parameters:

properties - properties

getValues

public HashMap getValues()

Description copied from interface: IResourceContext

Returns the internal properties map as is without copying them to be used and possible modified from outside.

Specified by:

getValues in interface IResourceContext

Returns:

properties

getLocale

public Locale getLocale()

Description copied from interface: IResourceContext

Get the locale for that context.

Specified by:

getLocale in interface IResourceContext

Returns:

Locale the locale to use.

See Also:

Locale

setLocale

public void setLocale(Locale locale)

Description copied from interface: IResourceContext

Set the locale for that context.

Specified by:

setLocale in interface IResourceContext

Parameters:

locale - locale to be set

See Also:

Locale

setUser

public void setUser(com.sapportals.portal.security.usermanagement.IUser user)

Description copied from interface: IResourceContext

Set the current user for that context.

Specified by:

setUser in interface IResourceContext

Parameters:

user - user to be set

getUser

public com.sapportals.portal.security.usermanagement.IUser getUser()

Description copied from interface: IResourceContext

Get the current user for that context.

Specified by:

getUser in interface IResourceContext

Returns:

IUser the user.

cloneContext

public IResourceContext cloneContext()

Clone resource context.

toString

public String toString()