Skip navigation links

com.stellent.cis.client.api.scs.context
Interface ISCSContext

All Superinterfaces:

ICISObjectInitializable, IContext, java.io.Serializable

public interface ISCSContext

extends IContext, ICISObjectInitializable

Represents a users operating context while interacting with the Content Server.

Nested Class Summary

static interface	ISCSContext.NTLMCredentials Credentials for NTLM
static interface	ISCSContext.UsernameCrendentials Basic credentials

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Field Summary

static java.lang.String

SCSCONTEXT_ID

Method Summary

void	clearRequestHeaders() Clear all custom request headers
java.lang.Object	getCrendentials()
java.lang.String	getEncoding()
java.lang.String	getIdcUser() Get the IDC user (i.e.
java.lang.String	getRequestHeader(java.lang.String header)
java.util.Collection	getRequestHeaderNames()
boolean	isRequestHeadersPresent()
void	removeRequestHeader(java.lang.String header) Remove the header from this context
void	setCrendentials(java.lang.Object credentials) Set an object that represents the credentials for this request; only used when adapter supports this (usually via going through the web interface)
void	setEncoding(java.lang.String encoding) Set the encoding to use for the requests to the content server
void	setIdcUser(java.lang.String idcUser)
void	setRequestHeader(java.lang.String header, java.lang.String value) Set a header on the context

Methods inherited from interface com.stellent.cis.client.context.IContext

getAdapterName, getContextPath, getDevice, getLocale, getSessionID, getUser, isGuest, setAdapterName, setContextPath, setDevice, setGuest, setLocale, setSessionID, setUser

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Field Detail

SCSCONTEXT_ID

static final java.lang.String SCSCONTEXT_ID

See Also:

Constant Field Values

Method Detail

getIdcUser

java.lang.String getIdcUser()

Get the IDC user (i.e. the content server user account used with this user)

Returns:

the user ID for the content server; if not set, this returns the value of IContext.getUser()

setIdcUser

void setIdcUser(java.lang.String idcUser)

Parameters:

idcUser -

setRequestHeader

void setRequestHeader(java.lang.String header,
                      java.lang.String value)

Set a header on the context

Parameters:

header - the header name

value - the header value

removeRequestHeader

void removeRequestHeader(java.lang.String header)

Remove the header from this context

Parameters:

header - the header name

getRequestHeader

java.lang.String getRequestHeader(java.lang.String header)

Parameters:

header - the header name

Returns:

the header value or null if no such header exists

getRequestHeaderNames

java.util.Collection getRequestHeaderNames()

Returns:

a collection of Strings representing the request header names

isRequestHeadersPresent

boolean isRequestHeadersPresent()

Returns:

true if custom request headers are present

clearRequestHeaders

void clearRequestHeaders()

Clear all custom request headers

setEncoding

void setEncoding(java.lang.String encoding)

Set the encoding to use for the requests to the content server

Parameters:

encoding - the Java encoding string (i.e. "UTF8")

getEncoding

java.lang.String getEncoding()

Returns:

the encoding to use for this context

setCrendentials

void setCrendentials(java.lang.Object credentials)

Set an object that represents the credentials for this request; only used when adapter supports this (usually via going through the web interface)

Parameters:

credentials - the user crendentials

getCrendentials

java.lang.Object getCrendentials()

Returns:

a token containing the appropiate crendentials for this user

Skip navigation links