com.ibm.itim.remoteservices.provider

Interface PlatformContext

All Known Implementing Classes:

InitialPlatformContext

public interface PlatformContext

Interface to retrieve provisioning platform context information, such as a directory naming context for retrieving directory entries. This interface is used for asynchronous communication and event notification by protocol implementers wishing to call back into the ITIM system.

An instance of a class implementing this interface should be obtained from the class InitialPlatformContext. A protocol implementer should obtain an instance of a class implementing this interface and then use it to complete processing of the asynchronous request or unsolicited event.

See Also:

Notifier, DirContext, InitialPlatformContext

Method Summary

Modifier and Type	Method and Description
javax.naming.directory.DirContext	getDirectoryContext() Deprecated. See UnsolicitedNotificationHandler.findService().
Notifier	getNotifier() Retrieves a new Notifier for notifying the platform or request responses.
UnsolicitedEventProcessor	getUnsolicitedEventProcessor() Retrieves a new UnsolicitedEventProcessor for processing unsolicited notification requests.
void	setSubject(javax.security.auth.Subject subject) Sets the subject for authentication and authorization.

Method Detail

getNotifier

Notifier getNotifier()
              throws RemoteServicesException

Retrieves a new Notifier for notifying the platform or request responses.

Returns:

A new, non-null Notifier instance.

Throws:

RemoteServicesException - Thrown on error.

getUnsolicitedEventProcessor

UnsolicitedEventProcessor getUnsolicitedEventProcessor()
                                                throws RemoteServicesException

Retrieves a new UnsolicitedEventProcessor for processing unsolicited notification requests.

Returns:

A new UnsolicitedEventProcessor.

Throws:

RemoteServicesException - Thrown on error

getDirectoryContext

javax.naming.directory.DirContext getDirectoryContext()
                                               throws javax.naming.NamingException

Deprecated. See UnsolicitedNotificationHandler.findService().

Retrieves a new directory naming context that can be used to query the platform's data store.

Returns:

A non-null DirContext instance.

Throws:

javax.naming.NamingException - Thrown if unable to create the DirContext.

setSubject

void setSubject(javax.security.auth.Subject subject)

Sets the subject for authentication and authorization. After authenticating with a loginContext the client should set the subject to allow for authentication.

Parameters:

subject - The subject for authentication and authorization. subject cannot be null.