Package oracle.stellent.ridc

Class IdcContext

java.lang.Object
oracle.stellent.ridc.IdcContext
@Exported public class IdcContext extends Object
Holds user-specific information needed to execute a Content Server service.

  • Field Details

    • USER_AGENT

      public static final String USER_AGENT
      See Also:

    • JSESSION_ID

      public static final String JSESSION_ID
      default session ID cookie for Content Server
      See Also:

    • 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:

    • DEFAULT_ENCODING

      public static final String DEFAULT_ENCODING
      default encoding
      See Also:

    • 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:

    • 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:

  • Constructor Details

    • 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 Details

    • 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

    • clearHeader

      public void clearHeader(String name)
      Clear the specified header

    • 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