IdcContext (Oracle Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC))

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

```
@Exported
public class IdcContext
extends Object
```
Holds user-specific information needed to execute a Content Server service.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IdcContext.HttpAuthScheme` Http authentication schema
`static class`	`IdcContext.LoginForm` Form information to allow login to clients with form-based authentication

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ENCODING` default encoding
`static String`	`DEFAULT_USER` applications are using this!
`static IdcContext.LoginForm`	`JAAS_FORM` standard form configuration for an application server JAAS login
`static String`	`JSESSION_ID` default session ID cookie for Content Server
`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 String`	`RIDC_INTERNAL_PARAM_PREFIX` parameter name prefix for internal-use RIDC parameters stored in parameters map
`static String`	`UCM_SESSION_ID` old cookie name used on Content Server before revision 87672 in the 11.1.1.4.0 branch (8/16/2010)
`static String`	`USER_AGENT`

Constructor Summary

Constructors
Constructor and Description
`IdcContext()`
`IdcContext(Credentials credentials)`
`IdcContext(String user)`
`IdcContext(String user, char[] password)`
`IdcContext(String user, Credentials credentials)` Deprecated.
`IdcContext(String user, String password)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addHeader(String name, 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()`
`RIDCCookie`	`getCookie(String name)` Retrieve a cookie by name
`Set<String>`	`getCookieNames()`
`Map<String,RIDCCookie>`	`getCookies()` Retrieve the cookies map
`Credentials`	`getCredentials()`
`String`	`getEncoding()`
`String`	`getHeader(String name)` Retrieve the header value for the given name
`Set<String>`	`getHeaderNames()`
`Map<String,String>`	`getHeaders()`
`IdcContext.LoginForm`	`getLoginForm()`
`Object`	`getParameter(String name)` Retrieve the parameter value for the given name
`String`	`getParameterAsString(String name)` Retreieve the parameter value for the given name as a String
`Set<String>`	`getParameterNames()`
`Map<String,Object>`	`getParameters()` Retrieve the parameters map
`String`	`getSessionCookie()` The name of the session cookie.
`String`	`getUser()`
`String`	`getUserAgent()`
`boolean`	`hasCredentials()`
`void`	`recordImpersonatee(String impersonatee)` Record the name of the person being impersonated.
`String`	`retrieveImpersonatee()` Retrieve the name of the person recorded as being impersonated.
`void`	`setAuthScheme(IdcContext.HttpAuthScheme authScheme)`
`void`	`setCookies(Map<String,RIDCCookie> cookies)` Set the cookies to use for subsequent sendRequest() calls.
`void`	`setCredentials(Credentials credentials)` Set some credentials for this context.
`void`	`setEncoding(String encoding)` Set the encoding to use
`void`	`setLoginForm(IdcContext.LoginForm loginForm)`
`void`	`setParameter(String name, Object value)` Set a parameter into this request
`void`	`setSessionCookie(String sessionCookie)`
`void`	`setUser(String user)` Deprecated.
`void`	`setUserAgent(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 String USER_AGENT
```
    See Also:
    
    Constant Field Values
  - JSESSION_ID
```
public static final String JSESSION_ID
```
    default session ID cookie for Content Server
    
    See Also:
    
    Constant Field Values
  - UCM_SESSION_ID
```
public static final String UCM_SESSION_ID
```
    old cookie name used on Content Server before revision 87672 in the 11.1.1.4.0 branch (8/16/2010)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENCODING
```
public static final String DEFAULT_ENCODING
```
    default encoding
    
    See Also:
    
    Constant Field Values
  - RIDC_INTERNAL_PARAM_PREFIX
```
public static final String RIDC_INTERNAL_PARAM_PREFIX
```
    parameter name prefix for internal-use RIDC parameters stored in parameters map
    
    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 String DEFAULT_USER
```
    applications are using this!
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IdcContext
```
public IdcContext()
```
  - IdcContext
```
public IdcContext(String user)
```
  - IdcContext
```
@Deprecated
public IdcContext(String user,
                              String password)
```
    Deprecated.
  - IdcContext
```
public IdcContext(String user,
                  char[] password)
```
  - IdcContext
```
public IdcContext(Credentials credentials)
```
  - IdcContext
```
@Deprecated
public IdcContext(String user,
                              Credentials credentials)
```
    Deprecated.
    
    Parameters:
    
    user -
    
    credentials -
    
    Throws:
    
    IllegalArgumentException - if the user doesn't match the credential's user
- Method Detail
  - getUser
```
public String getUser()
               throws IllegalArgumentException
```
    Returns:
    
    the user name
    
    Throws:
    
    IllegalArgumentException
  - setUser
```
@Deprecated
public void setUser(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:
    
    IllegalArgumentException
  - retrieveImpersonatee
```
public String retrieveImpersonatee()
```
    Retrieve the name of the person recorded as being impersonated.
    
    Returns:
    
    the person being impersonated
  - recordImpersonatee
```
public void recordImpersonatee(String impersonatee)
```
    Record the name of the person being impersonated. This method does NOT setup/configure/enable impersonation! It is used only for logging/recording purposes.
    
    Parameters:
    
    impersonatee - person being impersonated
  - 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 String getEncoding()
```
    Returns:
    
    the encoding to use for this context
  - setEncoding
```
public void setEncoding(String encoding)
```
    Set the encoding to use
    
    Parameters:
    
    encoding - the encoding
  - getUserAgent
```
public String getUserAgent()
```
    Returns:
    
    the user-agent value that is sent with this context
  - setUserAgent
```
public void setUserAgent(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 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(String sessionCookie)
```
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Add a header to this request
    
    Parameters:
    
    name - the header name
    
    value - the header value
  - getHeader
```
public String getHeader(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 Set<String> getHeaderNames()
```
    Returns:
    
    a set of the header names
  - clearHeaders
```
public void clearHeaders()
```
    Clear the available headers
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Returns:
    
    a map of the header
  - setCookies
```
public void setCookies(Map<String,RIDCCookie> cookies)
```
    Set the cookies to use for subsequent sendRequest() calls.
    
    Parameters:
    
    cookies - the cookie to leverage for new requests
  - getCookies
```
public Map<String,RIDCCookie> getCookies()
```
    Retrieve the cookies map
    
    Returns:
    
    the cookies to leverage for next request
  - getCookie
```
public RIDCCookie getCookie(String name)
```
    Retrieve a cookie by name
    
    Parameters:
    
    name - the cookie name
    
    Returns:
    
    the cookie or null if not found
  - getCookieNames
```
public Set<String> getCookieNames()
```
    Returns:
    
    a set of the configured cookies
  - clearCookies
```
public void clearCookies()
```
    Clear all cookies
  - setParameter
```
public void setParameter(String name,
                         Object value)
```
    Set a parameter into this request
    
    Parameters:
    
    name - the header name
    
    value - the header value
  - getParameter
```
public Object getParameter(String name)
```
    Retrieve the parameter value for the given name
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the value or null if not set
  - getParameterAsString
```
public String getParameterAsString(String name)
```
    Retreieve the parameter value for the given name as a String
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the String value or null if not set
  - getParameterNames
```
public Set<String> getParameterNames()
```
    Returns:
    
    a set of the parameter names
  - clearParameters
```
public void clearParameters()
```
    Clear the available parameters
  - getParameters
```
public Map<String,Object> getParameters()
```
    Retrieve the parameters map
    
    Returns:
    
    the map

Class IdcContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_AGENT

JSESSION_ID

UCM_SESSION_ID

DEFAULT_ENCODING

RIDC_INTERNAL_PARAM_PREFIX

JAAS_FORM

OAM_SSO_FORM

OIM_SSO_FORM

DEFAULT_USER

Constructor Detail

IdcContext

IdcContext

IdcContext

IdcContext

IdcContext

IdcContext

Method Detail

getUser

setUser

retrieveImpersonatee

recordImpersonatee

hasCredentials

getCredentials

setCredentials

getEncoding

setEncoding

getUserAgent

setUserAgent

getLoginForm

setLoginForm

getAuthScheme

setAuthScheme

getSessionCookie

setSessionCookie

addHeader

getHeader

getHeaderNames

clearHeaders

getHeaders

setCookies

getCookies

getCookie

getCookieNames

clearCookies

setParameter

getParameter

getParameterAsString

getParameterNames

clearParameters

getParameters