Package oracle.stellent.ridc.protocol.http

Class IdcHttpProtocol

java.lang.Object

oracle.stellent.ridc.protocol.http.IdcHttpProtocol

All Implemented Interfaces:

Protocol

@Concealed
public final class IdcHttpProtocol
extends Object
implements Protocol

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.stellent.ridc.protocol.Protocol

Protocol.NullHandlingStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDC_HTTP_METHOD
static final String	IDC_VERSION

Fields inherited from interface oracle.stellent.ridc.protocol.Protocol

IDC_HEADER_PREFIX, IDC_NULL_HANDLING, NULL_VALUE_OMIT, NULL_VALUE_TREAT_AS_EMPTYSTRING, NULL_VALUE_TREAT_AS_LOWERCASENULL

Constructor Summary

Constructors

Constructor	Description
IdcHttpProtocol(IdcHttpClient client, ServiceRequest<IdcHttpClientConnection> serviceRequest)

Method Summary

Modifier and Type	Method	Description
static void	addHandler(IdcContext.HttpAuthScheme authScheme, Class<? extends AuthenticationHandler> handler)	Add/replace a handler associated with the given authentication scheme
static void	addHandlerFirst(IdcContext.HttpAuthScheme authScheme, Class<? extends AuthenticationHandler> handler)	Add/replace a handler to be the first authentication scheme
static void	addHandlerLast(IdcContext.HttpAuthScheme authScheme, Class<? extends AuthenticationHandler> handler)	Add/replace a handler to be the last authentication scheme
protected void	addRequestData(RIDCHttpMethod httpMethod)	Set standard request headers, cookies and other info into the HTTP method.
protected void	addStringToBinder(String searchString, String htmlBody, DataBinder binder)
static AuthenticationHandler	createAuthHandler(IdcContext.HttpAuthScheme authScheme, IdcHttpProtocol httpProtocol)	Retrieve the authentication handler associated with the given authentication scheme
protected int	executeBinderMethod(List<NameValuePair> parameters, Boolean followRedirects)	Execute an HTTP method against the content server that POSTs a binder in HDA format
protected int	executeStreamMethod(List<NameValuePair> parameters)	Execute a multipart POST method against the content server that uploads the given files.
static Set<IdcContext.HttpAuthScheme>	getAuthSchemes()
IdcHttpClient	getClient()
IdcHttpClientConfig	getClientConfig()
IdcHttpClientConnection	getConnection()
DataBinder	getDataBinder()
DataFactory	getDataFactory()
protected List<NameValuePair>	getDefaultParameters()	Create a list of the default NameValuePair parameters
String	getEncoding()
IdcFilterManager	getFilterManager()
RIDCHttpClient	getHttpClient()
RIDCHttpMethod	getHttpMethod()
InputStream	getInputStream()
URI	getLastRequestURI()
IdcRequestConfig	getRequestConfig()
ServiceLog	getServiceLog()
ServiceRequest<IdcHttpClientConnection>	getServiceRequest()
IdcContext	getUserContext()
void	logout()	Best-effort Logout from Content Server
ServiceResponse	readResponse()	Reads the next message, if a message is not completely received within the timeout specified an exception is thrown.
static void	removeAllHandlers()	Removes all handlers associated with authentication schemes
static Class<? extends AuthenticationHandler>	removeHandler(IdcContext.HttpAuthScheme authScheme)	Removes a handler associated with the given authentication scheme
int	sendRequest()	Send the request to the Content Server; used internally by the AuthHandler implementations Same as sendRequest(null)
int	sendRequest(Boolean followRedirects)	Send the request to the Content Server; used internally by the AuthHandler implementations
void	setFilterManager(IdcFilterManager filterManager)
void	writeRequest()	Write the request to the Content Server

Methods inherited from class java.lang.Object

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

Field Details

IDC_VERSION

public static final String IDC_VERSION

See Also:

• Constant Field Values

IDC_HTTP_METHOD

public static final String IDC_HTTP_METHOD

See Also:

• Constant Field Values

Constructor Details

IdcHttpProtocol

public IdcHttpProtocol(IdcHttpClient client,
 ServiceRequest<IdcHttpClientConnection> serviceRequest)

Method Details

addHandler

public static void addHandler(IdcContext.HttpAuthScheme authScheme,
 Class<? extends AuthenticationHandler> handler)

Add/replace a handler associated with the given authentication scheme

Parameters:

authScheme - the auth scheme

handler - the authentication handler

addHandlerFirst

public static void addHandlerFirst(IdcContext.HttpAuthScheme authScheme,
 Class<? extends AuthenticationHandler> handler)

Add/replace a handler to be the first authentication scheme

Parameters:

authScheme - the auth scheme

handler - the authentication handler

addHandlerLast

public static void addHandlerLast(IdcContext.HttpAuthScheme authScheme,
 Class<? extends AuthenticationHandler> handler)

Add/replace a handler to be the last authentication scheme

Parameters:

authScheme - the auth scheme

handler - the authentication handler

removeHandler

public static Class<? extends AuthenticationHandler> removeHandler(IdcContext.HttpAuthScheme authScheme)

Removes a handler associated with the given authentication scheme

Parameters:

authScheme - the auth scheme

removeAllHandlers

public static void removeAllHandlers()

Removes all handlers associated with authentication schemes

getAuthSchemes

public static Set<IdcContext.HttpAuthScheme> getAuthSchemes()

Returns:

a set of the authentication schemes in the correct load order.

createAuthHandler

public static AuthenticationHandler createAuthHandler(IdcContext.HttpAuthScheme authScheme,
 IdcHttpProtocol httpProtocol)
                                               throws ProtocolException

Retrieve the authentication handler associated with the given authentication scheme

Parameters:

authScheme - the auth scheme

httpProtocol - the http protocol to initialize the auth handler

Returns:

a new authentication handler or null if not bound to the given scheme

Throws:

ProtocolException

getClient

public IdcHttpClient getClient()

Specified by:

getClient in interface Protocol

getDataFactory

public DataFactory getDataFactory()

getServiceRequest

public ServiceRequest<IdcHttpClientConnection> getServiceRequest()

getDataBinder

public DataBinder getDataBinder()

getUserContext

public IdcContext getUserContext()

getEncoding

public String getEncoding()

getClientConfig

public IdcHttpClientConfig getClientConfig()

getConnection

public IdcHttpClientConnection getConnection()

getRequestConfig

public IdcRequestConfig getRequestConfig()

getServiceLog

public ServiceLog getServiceLog()

getHttpClient

public RIDCHttpClient getHttpClient()

getHttpMethod

public RIDCHttpMethod getHttpMethod()

getInputStream

public InputStream getInputStream()
                           throws IOException,
ProtocolException

Throws:

IOException

ProtocolException

setFilterManager

public void setFilterManager(IdcFilterManager filterManager)

Specified by:

setFilterManager in interface Protocol

getFilterManager

public IdcFilterManager getFilterManager()

Specified by:

getFilterManager in interface Protocol

getLastRequestURI

public URI getLastRequestURI()

writeRequest

public void writeRequest()
                  throws ProtocolException

Write the request to the Content Server

Specified by:

writeRequest in interface Protocol

Throws:

ProtocolException

readResponse

public ServiceResponse readResponse()
                             throws ProtocolException

Reads the next message, if a message is not completely received within the timeout specified an exception is thrown.

Specified by:

readResponse in interface Protocol

Returns:

The received message.

Throws:

ProtocolException

logout

public void logout()
            throws ProtocolException

Description copied from interface: Protocol

Best-effort Logout from Content Server

Specified by:

logout in interface Protocol

Throws:

ProtocolException

sendRequest

public int sendRequest()
                throws ProtocolException

Send the request to the Content Server; used internally by the AuthHandler implementations Same as sendRequest(null)

Returns:

the http response code

Throws:

ProtocolException

sendRequest

public int sendRequest(Boolean followRedirects)
                throws ProtocolException

Send the request to the Content Server; used internally by the AuthHandler implementations

Parameters:

followRedirects - whether to follow redirects or not. null leaves it up to the protocol implementation

Returns:

the http response code

Throws:

ProtocolException

addStringToBinder

protected void addStringToBinder(String searchString,
 String htmlBody,
 DataBinder binder)

getDefaultParameters

protected List<NameValuePair> getDefaultParameters()

Create a list of the default NameValuePair parameters

Returns:

the default parameters

executeStreamMethod

protected int executeStreamMethod(List<NameValuePair> parameters)
                           throws IOException,
ProtocolException

Execute a multipart POST method against the content server that uploads the given files.

Parameters:

parameters - the default parameters

Returns:

the status code

Throws:

IOException

ProtocolException

executeBinderMethod

protected int executeBinderMethod(List<NameValuePair> parameters,
 Boolean followRedirects)
                           throws IOException,
ProtocolException

Execute an HTTP method against the content server that POSTs a binder in HDA format

Parameters:

parameters - the default parameters

followRedirects - whether to follow redirects or not. null leaves it up to the protocol implementation

Returns:

the response code

Throws:

IOException

ProtocolException

addRequestData

protected void addRequestData(RIDCHttpMethod httpMethod)

Set standard request headers, cookies and other info into the HTTP method. Also takes headers from the binder object if available.

Parameters:

httpMethod - the http method to set the parameters