|
Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference 11g Release 1 (11.1.1) E17274-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.ridc.IdcContext
public class IdcContext
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 default user ID |
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 java.lang.String |
UCM_SESSION_ID default session ID cookie for UCM |
static java.lang.String |
USER_AGENT |
Constructor Summary | |
---|---|
IdcContext() |
|
IdcContext(java.lang.String user) |
|
IdcContext(java.lang.String user, Credentials credentials) |
|
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 |
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.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 |
setSessionCookie(java.lang.String sessionCookie) |
void |
setUser(java.lang.String user) Set the user name for this context |
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 |
---|
public static final java.lang.String USER_AGENT
public static final java.lang.String UCM_SESSION_ID
public static final java.lang.String DEFAULT_USER
public static final java.lang.String DEFAULT_ENCODING
public static IdcContext.LoginForm JAAS_FORM
public static IdcContext.LoginForm OAM_SSO_FORM
Constructor Detail |
---|
public IdcContext()
public IdcContext(java.lang.String user)
public IdcContext(java.lang.String user, java.lang.String password)
public IdcContext(java.lang.String user, Credentials credentials)
Method Detail |
---|
public java.lang.String getUser()
public void setUser(java.lang.String user)
user
- the user namepublic boolean hasCredentials()
public Credentials getCredentials()
public void setCredentials(Credentials credentials)
credentials
- the credentialspublic java.lang.String getEncoding()
public void setEncoding(java.lang.String encoding)
encoding
- the encodingpublic java.lang.String getUserAgent()
public void setUserAgent(java.lang.String userAgent)
userAgent
- the user agent to usepublic IdcContext.LoginForm getLoginForm()
public void setLoginForm(IdcContext.LoginForm loginForm)
public IdcContext.HttpAuthScheme getAuthScheme()
public void setAuthScheme(IdcContext.HttpAuthScheme authScheme)
public java.lang.String getSessionCookie()
public void setSessionCookie(java.lang.String sessionCookie)
public void addHeader(java.lang.String name, java.lang.String value)
name
- the header namevalue
- the header valuepublic java.lang.String getHeader(java.lang.String name)
name
- the header namepublic java.util.Set<java.lang.String> getHeaderNames()
public void clearHeaders()
public void addCookie(IdcContext.Cookie cookie)
cookie
- the cookie to send with each requestpublic IdcContext.Cookie getCookie(java.lang.String name)
name
- the cookie namepublic java.util.Set<java.lang.String> getCookieNames()
public void clearCookies()
|
Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference 11g Release 1 (11.1.1) E17274-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |