com.sapportals.wcm.util.http

Interface IRequesterFactory

All Known Implementing Classes:

SlimRequesterFactory

public interface IRequesterFactory

A requester factory is able to handle out new IWDRequester for a given base URL. Context information can be supplied when the connection to the remote URL requires Authorization.

For efficient reuse of requester, it is best to acquire the IWDContext objects through the factory interface. At the moment there is only support for user/password Authorization in this interface.

Copyright (c) SAP AG 2001-2002

Method Summary

Modifier and Type	Method and Description
String	getAbsoluteURL(String uri)
HttpUrl	getBase()
IContext	getContext(Object key)
int	getPort()
IRequester	getRequester(IContext context)
int	getSoTimeout() Returns the timeout used for socket operations.
void	setBaseURL(String url) Set the base URL for this factory.
void	setMaxConnections(int max) Set the maximum number of concurrent connections.
void	setProxyInfo(IProxyInfo info) Sets the proxy information to use by this factory.
void	setSoTimeout(int ms) Sets the timeout for socket operations.
void	shutdown() Free up all resource used by this factory.

Method Detail

getBase

HttpUrl getBase()

Returns:

the installed base URL

getPort

int getPort()

Returns:

the port number

getAbsoluteURL

String getAbsoluteURL(String uri)

Parameters:

uri - TBD: Description of the incoming method parameter

Returns:

the full URL for the given relative URI

getContext

IContext getContext(Object key)

Parameters:

key - TBD: Description of the incoming method parameter

Returns:

a IWDContext for the given key (e.g. username)

setBaseURL

void setBaseURL(String url)
         throws MalformedURLException

Set the base URL for this factory. Needs to be called before first requester is retrieved and should not be changed afterwards.

Parameters:

url - baseURL to be set

Throws:

MalformedURLException - Exception raised in failure situation

setProxyInfo

void setProxyInfo(IProxyInfo info)

Sets the proxy information to use by this factory.

Parameters:

info - proxyInfo to be set

getRequester

IRequester getRequester(IContext context)
                 throws WcmException

Parameters:

context - needed for authorized connections or null for anonymous requests

Returns:

IWDRequester for the given context.

Throws:

WcmException - Exception raised in failure situation

getSoTimeout

int getSoTimeout()

Returns the timeout used for socket operations. A timeout value of 0 means infinite timeout.

Returns:

the timeout (milliseconds) used for socket operations

setSoTimeout

void setSoTimeout(int ms)

Sets the timeout for socket operations. A value of 0 means inifinite wait.

Parameters:

ms - soTimeout to be set

setMaxConnections

void setMaxConnections(int max)

Set the maximum number of concurrent connections.

Parameters:

max - maximum number of connections

shutdown

void shutdown()

Free up all resource used by this factory.