public interface IContext
Copyright (c) SAP AG 2001-2002
Modifier and Type | Method and Description |
---|---|
boolean |
appliesCredentials()
Answer if authorization credentials are used in this context.
|
boolean |
applyCredentials(IRequester requester,
String uri,
IRequest request)
Apply the credentials for a HTTP request.
|
boolean |
canTriggerAuthentication(IRequester requester)
Return if authentication responses (HTTP 401) can be triggered in this
context.
|
void |
endUse(IRequester requester)
This context will no longer be used for the given requester
|
String |
getCookieHeaderValue(HttpUrl requestUri)
Return string in HTTP header value format for cookies in this context.
|
Map |
getCookies() |
UserInfo |
getProxyUserInfo()
Return user info for proxy server
|
ICredentials |
getSpecialCredentials()
Return any installed special credentials or
null if none is
installed |
UserInfo |
getUserInfo()
Return user info for this context.
|
boolean |
isNew() |
void |
openedConnection(IRequester requester)
New connection in requester was opened for this context.
|
void |
responseCredentials(IRequester requester,
IResponse response)
Give the context the possiblity to process authenticate information in the
response message, like Authenticate-Info.
|
void |
setCookie(ICookie cookie)
Sets a new cookie in this context
|
void |
setProxyUserInfo(UserInfo ui)
Sets username/password to be used in this context for proxy.
|
void |
setSpecialCredentials(ICredentials handler)
Set a special credentials handler which is run before any of the known
authentication schemes (basic, digest) are run.
|
boolean |
setupCredentials(IRequester requester,
Headers header)
Set the credentials for this context depending on the header information
(received from a 401 response).
|
boolean |
setupProxyCredentials(IRequester requester,
Headers header)
Set the credentials for this context depending on the header information
(received from a 407 response).
|
void |
setUserInfo(UserInfo ui)
Sets username/password to be used in this context.
|
void |
startUse(IRequester requester)
This context will be used for the given requester
|
UserInfo getUserInfo()
UserInfo getProxyUserInfo()
Map getCookies()
String getCookieHeaderValue(HttpUrl requestUri)
null
.requestUri
- TBD: Description of the incoming method parameternull
boolean isNew()
void setCookie(ICookie cookie)
cookie
- void setUserInfo(UserInfo ui)
ui
- userInfo to be setvoid setProxyUserInfo(UserInfo ui)
ui
- proxyUserInfo to be setboolean appliesCredentials()
boolean applyCredentials(IRequester requester, String uri, IRequest request) throws WcmException
setupCredentials
. The credentials are
applied to the request header fields.uri
- the requested urirequest
- the request to calculate the credentials forrequester
- TBD: Description of the incoming method parameterWcmException
- Exception raised in failure situationboolean setupCredentials(IRequester requester, Headers header) throws WcmException
requester
- TBD: Description of the incoming method parameterheader
- TBD: Description of the incoming method parameterWcmException
- Exception raised in failure situationboolean setupProxyCredentials(IRequester requester, Headers header) throws WcmException
requester
- TBD: Description of the incoming method parameterheader
- TBD: Description of the incoming method parameterWcmException
- Exception raised in failure situationvoid responseCredentials(IRequester requester, IResponse response) throws WcmException
requester
- TBD: Description of the incoming method parameterresponse
- TBD: Description of the incoming method parameterWcmException
- Exception raised in failure situationvoid setSpecialCredentials(ICredentials handler)
handler
- to installed (or null
to remove)ICredentials getSpecialCredentials()
null
if none is
installedvoid openedConnection(IRequester requester)
requester
- which opened new connectionvoid startUse(IRequester requester)
requester
- void endUse(IRequester requester)
requester
- boolean canTriggerAuthentication(IRequester requester)
requester
- to work inAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice