Package com.sun.im.provider

Sun ONE Instant Messaging Service Provider Interfaces

Sun ONE Instant Messaging supports the following types of service provider modules: Authentication/SSO providers and message archive providers.

See:
          Description

Interface Summary
AccessControlList  
ByteStream  
ByteStreamBlock  
ConferenceManager  
ConferenceStorageProvider conference storage interface.
ConferenceStore news storage interface.
ConfigReader  
FilterParser.CollectionEvaluator  
FilterParser.Evaluator  
NewsArchiveProvider News Channel Archive Provider interface.
NewsStorageProvider news storage interface.
PollArchiveProvider Poll Archive Provider interface.
Realm Abstact class to get list of users/groups and authenticate them.
RealmSearchResults  
Redirector A redirector tells whether a session should be redirected to another host and if so what is the redirection target.
SASLRealm Any Realm which wants to exhibit SASL support should implement this interface
SASLServerProvider A SASL server provider allows for extending the IM server to support custom SASL protocols.
ServerConference  
SSOProvider An SSO provider lets the IM server take advantage of a single-sign-on service.
UserSettingsStorageProvider  
 

Class Summary
AccessControlItem Convenience methods for provider modules
ArchiveProvider Archive Provider base class.
ByteStreamFilter Streamed content filtering provider All binary data of files exchanged by users through the server are transferred as follows: First a byte stream is created.
DocumentConverter Document converter base class.
FilterParser Very insufficient LDIF parser to be used until we can leverage a real one.
MessageConverter Message converter base class.
PolicyProvider Does policy evaluation regardless of Policy store used
PolicyProvider.AccessLevelResult This class is used to give results with specific access levels
PolicyProvider.Result This class defines the results which can be returned after the evaluation of policy
ServerUtility  
 

Exception Summary
RealmException Generic Exception thrown in Realm action
 

Package com.sun.im.provider Description

Sun ONE Instant Messaging Service Provider Interfaces



Sun ONE Instant Messaging supports the following types of service provider modules: Authentication/SSO providers and message archive providers.



The Authentication Provider SPI

By default Sun ONE Instant Messaging leverages the Sun ONE Identity Server Authentication and Single-Sign-On framework. An Authentication provider module can be used to deploy Sun ONE Instant Messaging within an alternative authentication system. This type of provider features one method which is invoked each time the server performs a user authentication. Sun ONE Instant Messaging Server can be configured to invoke a custom authentication provider using the following configuration options in iim.conf

iim_server.usesso specifies whether or not to use custom authentication and whether to fallback to default LDAP authentication in case SSO authentication fails. The supported integer values are

iim_server.ssoprovider specifies the class implementing SSOProvider. If iim_server.usesso is not equal to 0 and this option is not set, the default Identity Server-based Authentication Provider is used.



The Message Archive Provider SPI

This interface allows Sun ONE Instant Messaging Server to archive messages traversing it. It also allows for archiving of conference creation, destruction, join and leave events. Sun ONE Instant Messaging includes a default basic archive provider. However, more useful archive provider based on sphisticated knowledge management systems could be created using this interface. Archiving in Sun ONE Instant Messaging is controlled by the following configuration options:

iim_server.msg_archive specifies whether to turn archiving on or off. It supports the values “true” or “false”.

iim_server.msg_archive.provider specified the ArchiveProvider implementation class. If archiving is turned on and this option is not specified, the default basic archive provider is used.

iim_server.msg_archive.url specifies the name of the file which the default archive provider uses. The default is <log-directory>/iim_msg.log.

This documentation included a sample ArchiveProvider implementation source code.



The Message Conversion SPI

The Message conversion API is used to perform scanning and filtering of messages as they pass through Sun ONE Instant Messaging Server. For each message, all configured Message Conversion providers are invoked in the order in which they are configured.

This API lets Message Conversion providers access the text as well as the file attachements (if any) of each message. providers may also alter the content of processed messages, such as removing or modifying attachments. Configuraing a conversion provider can be very useful in order to perform virus-scanning.

To enable message conversion, set the following options in the server configuration:

Sun ONE Instant messaging includes a sample message conversion module called com.iplanet.im.server.ExternalDocumentConverter. It performs conversion of message attachments (not text) by invoking a separate command. The external command format is provided by the server configuration option: iim_server.conversion.external.command. The command line format may use the following macros: Example: The return values of the external command are interpreted by the provider and must therefore comply to the following specification