HttpRequestInterceptorList Interface Reference

Provides access to an ordered list of request interceptors. More...

Inheritance diagram for HttpRequestInterceptorList:

Description

Lists are expected to be built upfront and used read-only afterwards for processing .

Author

Roland Weber

Version

Revision

554903

Since

4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
void	addRequestInterceptor (HttpRequestInterceptor itcp)
	Appends a request interceptor to this list. More...
void	addRequestInterceptor (HttpRequestInterceptor itcp, int index)
	Inserts a request interceptor at the specified index. More...
int	getRequestInterceptorCount ()
	Obtains the current size of this list. More...
HttpRequestInterceptor	getRequestInterceptor (int index)
	Obtains a request interceptor from this list. More...
void	clearRequestInterceptors ()
	Removes all request interceptors from this list.
void	removeRequestInterceptorByClass (Class clazz)
	Removes all request interceptor of the specified class. More...
void	setInterceptors (List itcps)
	Sets the request interceptors in this list. More...

Member Function Documentation

addRequestInterceptor() [1/2]

void addRequestInterceptor

(

HttpRequestInterceptor

itcp

)

Parameters

itcp	the request interceptor to add

Implemented in BasicHttpProcessor.

addRequestInterceptor() [2/2]

void addRequestInterceptor	(	HttpRequestInterceptor	itcp,
		int	index
	)

Parameters

itcp	the request interceptor to add
index	the index to insert the interceptor at

Implemented in BasicHttpProcessor.

getRequestInterceptorCount()

int getRequestInterceptorCount

(

)

Returns

the number of request interceptors in this list

Implemented in BasicHttpProcessor.

getRequestInterceptor()

HttpRequestInterceptor getRequestInterceptor

(

int

index

)

Parameters

index

the index of the interceptor to obtain, 0 for first

Returns

the interceptor at the given index, or null if the index is out of range

Implemented in BasicHttpProcessor.

removeRequestInterceptorByClass()

void removeRequestInterceptorByClass

(

Class

clazz

)

Parameters

clazz

the class of the instances to be removed.

Implemented in BasicHttpProcessor.

setInterceptors()

void setInterceptors

(

List

itcps

)

This list will be cleared and re-initialized to contain all request interceptors from the argument list. If the argument list includes elements that are not request interceptors, the behavior is implementation dependent.

Parameters

itcps

the list of request interceptors

Implemented in BasicHttpProcessor.