com.sap.netweaver.bc.rf.common.context

Interface IAccessContext

All Known Implementing Classes:

AccessContext

public interface IAccessContext

Interface describing the access context information the system needs to know, when working on resources.

Field Summary

static String	TRANSPORT_EXPORT Defines the parameter name for the #getValue(String) method.
static String	TRANSPORT_IMPORT Defines the parameter name for the #getValue(String) method.

Method Summary

IAccessContext	cloneContext() Clone access context.
long	getAllowedStaleDataTimespan() Get time the repository data may not be older than.
Map	getClientDefinedProperties() Returns a map containing all client defined properties
Object	getClientDefinedProperty(String name) Get a client defined property from the context.
String	getClientId() Get id of the current client operating on the resouce.
Locale	getLocale() Get locale of the current user.
String	getTuccId() Returns the TUCC transaction identifier - can be null.
com.sap.security.api.IUser	getUser() Get current user operating on the resouce.
Map	getVariantContext() Returns a map of context properties used for variant handling - may be null.
void	setAllowedStaleDataTimespan(long allowedStaleDataTimespan) Set time the repository data may not be older than.
void	setClientDefinedProperty(String name, Object value) Set a client defined property in the context.
void	setClientId(String clientId) Set id of the current client operating on the resouce.
void	setLocale(Locale locale) Set locale of the current user.
void	setUser(com.sap.security.api.IUser user) Set current user operating on the resouce.

Field Detail

TRANSPORT_IMPORT

static final String TRANSPORT_IMPORT

Defines the parameter name for the #getValue(String) method. The framework will set this parameter as a flag (returned value is not null) to indicate to a repository that the createXXX() method is used to create a deserialized resource as part of a import of the transport service.

See Also:

Constant Field Values

TRANSPORT_EXPORT

static final String TRANSPORT_EXPORT

Defines the parameter name for the #getValue(String) method. The framework will set this parameter as a flag (returned value is not null) to indicate to a repository that the readXXX() method is used to read and deserialize aresource as part of an export of the transport service. see IResourceContext for parallel usage

See Also:

Constant Field Values

Method Detail

getClientId

String getClientId()

Get id of the current client operating on the resouce.

Returns:

id of the current client operating on the resouce

setClientId

void setClientId(String clientId)

Set id of the current client operating on the resouce.

Parameters:

clientId - id of the current client operating on the resouce

getUser

com.sap.security.api.IUser getUser()

Get current user operating on the resouce.

Returns:

current user operating on the resouce

setUser

void setUser(com.sap.security.api.IUser user)

Set current user operating on the resouce.

Parameters:

user - current user operating on the resouce

getLocale

Locale getLocale()

Get locale of the current user.

Returns:

locale of the current user

setLocale

void setLocale(Locale locale)

Set locale of the current user.

Parameters:

locale - locale of the current user

getAllowedStaleDataTimespan

long getAllowedStaleDataTimespan()

Get time the repository data may not be older than.

Returns:

time the repository data may not be older than

setAllowedStaleDataTimespan

void setAllowedStaleDataTimespan(long allowedStaleDataTimespan)

Set time the repository data may not be older than.

Parameters:

allowedStaleDataTimespan - The new allowedStaleDataTimespan value

getClientDefinedProperties

Map getClientDefinedProperties()

Returns a map containing all client defined properties

getClientDefinedProperty

Object getClientDefinedProperty(String name)

Get a client defined property from the context.

Parameters:

name - name of the client defined property

Returns:

value of the client defined property

setClientDefinedProperty

void setClientDefinedProperty(String name,
                              Object value)
                              throws RepositoryException

Set a client defined property in the context.

Parameters:

name - name of the client defined property

value - value of the client defined property

Throws:

RepositoryException - Exception raised in failure situation

cloneContext

IAccessContext cloneContext()

Clone access context.

Returns:

cloned access context

getVariantContext

Map getVariantContext()

Returns a map of context properties used for variant handling - may be null.

Returns:

a map of context properties used for variant handling - may be null.

getTuccId

String getTuccId()

Returns the TUCC transaction identifier - can be null.

Returns:

the TUCC transaction identifier - can be null.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM