com.ibm.itim.remoteservices.provider
Class InitialPlatformContext

java.lang.Object
  |
  +--com.ibm.itim.remoteservices.provider.InitialPlatformContext

All Implemented Interfaces:

PlatformContext

public class InitialPlatformContext

extends java.lang.Object

implements PlatformContext

Class used as a starting point to gain the platform's context. This class will front-end the platform's specific implementation. By either passing the full class name of the platform implementation, or by specifying the full class name in the platformcontext.properties file, this class will instantiate the correct implementation to be used in an implementation independent interface.

See Also:

Notifier, DirContext

Constructor Summary

InitialPlatformContext()
Deprecated. Use contructor with subject

InitialPlatformContext(java.lang.String platformClassName)
Deprecated. Use contructor with subject

InitialPlatformContext(javax.security.auth.Subject subject)
Constructs the InitialPlatformContext by reading the implementation class from the platformcontext.properties file.

InitialPlatformContext(javax.security.auth.Subject subject, java.lang.String platformClassName)
Constructs the InitialPlatformContext with the supplied PlatformContext implementation class.

Method Summary

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InitialPlatformContext

public InitialPlatformContext(javax.security.auth.Subject subject)
                       throws RemoteServicesException

Constructs the InitialPlatformContext by reading the implementation class from the platformcontext.properties file. If the user of this api does not wish have a dependency on the presence of the properties file, the other constructor may be used.

Parameters:

subject - already authenticated

Throws:

RemoteServicesException - thrown if unable to construct.

InitialPlatformContext

public InitialPlatformContext(javax.security.auth.Subject subject,
                              java.lang.String platformClassName)
                       throws RemoteServicesException

Constructs the InitialPlatformContext with the supplied PlatformContext implementation class. The class name used must be the full class name.

Parameters:

subject - already authenticated

platformClassName - Name of a class used to instantiate the implementation

Throws:

RemoteServicesException - thrown if unable to construct.

InitialPlatformContext

public InitialPlatformContext()
                       throws RemoteServicesException

Deprecated. Use contructor with subject

Constructs the InitialPlatformContext by reading the implementation class from the platformcontext.properties file.

Throws:

RemoteServicesException - thrown if unable to construct.

InitialPlatformContext

public InitialPlatformContext(java.lang.String platformClassName)
                       throws RemoteServicesException

Deprecated. Use contructor with subject

Constructs the InitialPlatformContext with the supplied PlatformContext implementation class. The class name used must be the fully qualified class name.

Parameters:

platformClassName - Name of the Java class implementing the PlatformContext interface. Cannot be null.

Throws:

RemoteServicesException - thrown if unable to construct.

Method Detail

getNotifier

public Notifier getNotifier()
                     throws RemoteServicesException

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

Specified by:

getNotifier in interface PlatformContext

Returns:

New Notifier instance. Notifier cannot be null.

Throws:

RemoteServicesException - on error

getUnsolicitedEventProcessor

public UnsolicitedEventProcessor getUnsolicitedEventProcessor()
                                                       throws RemoteServicesException

Retrieves a new UnsolicitedEventProcessor for processing unsolicited notification request.

Specified by:

getUnsolicitedEventProcessor in interface PlatformContext

Returns:

A new instance of UnsolicitedEventProcessor which cannot be null.

Throws:

RemoteServicesException - on error

getDirectoryContext

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

Deprecated. See UnsolicitedEventProcessor.findService().

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

Specified by:

getDirectoryContext in interface PlatformContext

Returns:

New DirContext instance which cannot be null.

Throws:

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

setSubject

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

Sets the subject for authentication and authorization

Specified by:

setSubject in interface PlatformContext

Parameters:

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

See Also:

PlatformContext.setSubject(javax.security.auth.Subject)