Package com.vignette.portal.rsm

Provides interfaces and classes for retrieving content from a remote site or entity in a protocol-agnostic manner.

See:
Package Summary

Interface Summary

Authenticator	Manages authentication and session maintenance on a remote server.
ByteToStringConverter	Converts an array of bytes into a String.
RemoteRequest	Represents a request to a remote server or resource.
RemoteResponse	Represents a response from a remote server.
RemoteSession	Models a session on a remote server.

Class Summary

RemoteSessionFactory	Factory for creating sessions for a given protocol.
RSMConfig	Provides properties and configuration for the RSM package.

Exception Summary

TimeoutException	Represents a timeout condition.
UnsupportedProtocolException	Represents a condition where an unsupported protocol has been passed to an instantiating object.

Package com.vignette.portal.rsm Description

Provides interfaces and classes for retrieving content from a remote site or entity in a protocol-agnostic manner.

Facilities are provided for authentication and session maintainence to the remote site.

This package replaces com.epicentric.common.WebData and com.epicentric.common.FileData.

Usage

Client code will start use of the API by creating a session. The RemoteSessionFactory object contains a factory method (createRemoteSession()) that creates a session for a given protocol. If the protocol is unknown or unsupported, an UnsupportedProtocolException is thrown.

try {
	RemoteSession session = RemoteSessionFactory.createRemoteSession("http");
} catch (UnsupportedProtocolException e) {}

This creates a representation in your code of a session on a remote server. The session object can then be cast to the appropriate protocol-specific session implementation to set specific session information:

	if (session instanceof HttpRemoteSession) {
		HttpRemoteSession http_session = (HttpRemoteSession)session;

		http_session.setUserAgent(HttpRemoteRequest.USER_AGENT_NETSCAPE_6_2_3);
		http_session.setRequestMethod(HttpRemoteRequest.HTTP_METHOD_GET);
	}

Since:

7.0

See Also:

com.vignette.portal.rsm.http, com.vignette.portal.rsm.file