Skip navigation links

oracle.stellent.ridc
Class IdcContext

java.lang.Object
oracle.stellent.ridc.IdcContext

public class IdcContext

extends java.lang.Object

Holds user-specific information needed to execute a Content Server service.

Nested Class Summary

static class	IdcContext.Cookie Represents a cookie value
static class	IdcContext.HttpAuthScheme Http authentication schema
static class	IdcContext.LoginForm Form information to allow login to clients with form-based authentication

Field Summary

static java.lang.String	DEFAULT_ENCODING default encoding
static java.lang.String	DEFAULT_USER applications are using this!
static IdcContext.LoginForm	JAAS_FORM standard form configuration for an application server JAAS login
static IdcContext.LoginForm	OAM_SSO_FORM standard form configuration for OAM SSO
static IdcContext.LoginForm	OIM_SSO_FORM standard form configuration for OIM SSO
static java.lang.String	UCM_SESSION_ID default session ID cookie for UCM
static java.lang.String	USER_AGENT

Constructor Summary

IdcContext()

IdcContext(Credentials credentials)

IdcContext(java.lang.String user)

IdcContext(java.lang.String user, Credentials credentials)
Deprecated.

IdcContext(java.lang.String user, java.lang.String password)

Method Summary

void	addCookie(IdcContext.Cookie cookie)
void	addHeader(java.lang.String name, java.lang.String value) Add a header to this request
void	clearCookies() Clear all cookies
void	clearHeaders() Clear the available headers
void	clearParameters() Clear the available parameters
IdcContext.HttpAuthScheme	getAuthScheme()
IdcContext.Cookie	getCookie(java.lang.String name) Retrieve a cookie by name
java.util.Set<java.lang.String>	getCookieNames()
Credentials	getCredentials()
java.lang.String	getEncoding()
java.lang.String	getHeader(java.lang.String name) Retrieve the header value for the given name
java.util.Set<java.lang.String>	getHeaderNames()
IdcContext.LoginForm	getLoginForm()
java.lang.Object	getParameter(java.lang.String name) Retrieve the parameter value for the given name
java.util.Set<java.lang.String>	getParameterNames()
java.lang.String	getSessionCookie() The name of the session cookie.
java.lang.String	getUser()
java.lang.String	getUserAgent()
boolean	hasCredentials()
void	setAuthScheme(IdcContext.HttpAuthScheme authScheme)
void	setCredentials(Credentials credentials) Set some credentials for this context.
void	setEncoding(java.lang.String encoding) Set the encoding to use
void	setLoginForm(IdcContext.LoginForm loginForm)
void	setParameter(java.lang.String name, java.lang.Object value) Set a parameter into this request
void	setSessionCookie(java.lang.String sessionCookie)
void	setUser(java.lang.String user) Deprecated.
void	setUserAgent(java.lang.String userAgent)

Methods inherited from class java.lang.Object

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

Field Detail

USER_AGENT

public static final java.lang.String USER_AGENT

See Also:

Constant Field Values

UCM_SESSION_ID

public static final java.lang.String UCM_SESSION_ID

default session ID cookie for UCM

See Also:

Constant Field Values

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING

default encoding

See Also:

Constant Field Values

JAAS_FORM

public static IdcContext.LoginForm JAAS_FORM

standard form configuration for an application server JAAS login

OAM_SSO_FORM

public static IdcContext.LoginForm OAM_SSO_FORM

standard form configuration for OAM SSO

OIM_SSO_FORM

public static IdcContext.LoginForm OIM_SSO_FORM

standard form configuration for OIM SSO

DEFAULT_USER

public static final java.lang.String DEFAULT_USER

applications are using this!

See Also:

Constant Field Values

Constructor Detail

IdcContext

public IdcContext()

IdcContext

public IdcContext(java.lang.String user)

IdcContext

public IdcContext(java.lang.String user,
                  java.lang.String password)

IdcContext

public IdcContext(Credentials credentials)

IdcContext

@Deprecated
public IdcContext(java.lang.String user,
                             Credentials credentials)

Deprecated.

Parameters:

user -

credentials -

Throws:

java.lang.IllegalArgumentException - if the user doesn't match the credential's user

Method Detail

getUser

public java.lang.String getUser()
                         throws java.lang.IllegalArgumentException

Returns:

the user name

Throws:

java.lang.IllegalArgumentException

setUser

@Deprecated
public void setUser(java.lang.String user)

Deprecated.

This method doesn't set the username and will throw an exception, do no use! Set the username in the appropriate credential class

Parameters:

user - the user name

Throws:

java.lang.IllegalArgumentException

hasCredentials

public boolean hasCredentials()

Returns:

if the context object is associated with some credentials

getCredentials

public Credentials getCredentials()

Returns:

the credentials if available

setCredentials

public void setCredentials(Credentials credentials)

Set some credentials for this context.

Parameters:

credentials - the credentials

getEncoding

public java.lang.String getEncoding()

Returns:

the encoding to use for this context

setEncoding

public void setEncoding(java.lang.String encoding)

Set the encoding to use

Parameters:

encoding - the encoding

getUserAgent

public java.lang.String getUserAgent()

Returns:

the user-agent value that is sent with this context

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Parameters:

userAgent - the user agent to use

getLoginForm

public IdcContext.LoginForm getLoginForm()

Returns:

the configured login form used for form-based authentication

setLoginForm

public void setLoginForm(IdcContext.LoginForm loginForm)

getAuthScheme

public IdcContext.HttpAuthScheme getAuthScheme()

Returns:

the authentication scheme to use

setAuthScheme

public void setAuthScheme(IdcContext.HttpAuthScheme authScheme)

getSessionCookie

public java.lang.String getSessionCookie()

The name of the session cookie. Some protocols utilize this value to track a specific cookie when sending requests to the Content Server.

Returns:

the name of the cookie which stores the session token

setSessionCookie

public void setSessionCookie(java.lang.String sessionCookie)

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Add a header to this request

Parameters:

name - the header name

value - the header value

getHeader

public java.lang.String getHeader(java.lang.String name)

Retrieve the header value for the given name

Parameters:

name - the header name

Returns:

the value or null if not set

getHeaderNames

public java.util.Set<java.lang.String> getHeaderNames()

Returns:

a set of the header names

clearHeaders

public void clearHeaders()

Clear the available headers

addCookie

public void addCookie(IdcContext.Cookie cookie)

Parameters:

cookie - the cookie to send with each request

getCookie

public IdcContext.Cookie getCookie(java.lang.String name)

Retrieve a cookie by name

Parameters:

name - the cookie name

Returns:

the cookie or null if not found

getCookieNames

public java.util.Set<java.lang.String> getCookieNames()

Returns:

a set of the configured cookies

clearCookies

public void clearCookies()

Clear all cookies

setParameter

public void setParameter(java.lang.String name,
                         java.lang.Object value)

Set a parameter into this request

Parameters:

name - the header name

value - the header value

getParameter

public java.lang.Object getParameter(java.lang.String name)

Retrieve the parameter value for the given name

Parameters:

name - the header name

Returns:

the value or null if not set

getParameterNames

public java.util.Set<java.lang.String> getParameterNames()

Returns:

a set of the parameter names

clearParameters

public void clearParameters()

Clear the available parameters

Skip navigation links