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

Constructor Summary

InitialPlatformContext()
Deprecated. Use the contructor with a Subject parameter.

InitialPlatformContext(java.lang.String platformClassName)
Deprecated. Use the contructor with a Subject parameter.

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() Retrieves a new directory naming context that can be used to query the platform's data store.
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.

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 - The subject should already be authenticated.

Throws:

RemoteServicesException - Thrown if unable to construct a new InitialPlatformContext.

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 - The subject should already be authenticated.

platformClassName - The full classname used to instantiate the implementation.

Throws:

RemoteServicesException - Thrown if unable to construct a new InitialPlatformContext.

InitialPlatformContext

public InitialPlatformContext()
                       throws RemoteServicesException

Deprecated. Use the contructor with a Subject parameter.

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

Throws:

RemoteServicesException - Thrown if unable to construct a new InitialPlatformContext.

InitialPlatformContext

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

Deprecated. Use the contructor with a Subject parameter.

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

Parameters:

platformClassName - The full classname of the Java class that implements PlatformContext. This parameter cannot be null.

Throws:

RemoteServicesException - Thrown if unable to construct.

Method Detail

getNotifier

public Notifier getNotifier()
                     throws RemoteServicesException

Description copied from interface: PlatformContext

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

Specified by:

getNotifier in interface PlatformContext

Returns:

A new, non-null Notifier instance.

Throws:

RemoteServicesException - Thrown on error.

getUnsolicitedEventProcessor

public UnsolicitedEventProcessor getUnsolicitedEventProcessor()
                                                       throws RemoteServicesException

Description copied from interface: PlatformContext

Retrieves a new UnsolicitedEventProcessor for processing unsolicited notification requests.

Specified by:

getUnsolicitedEventProcessor in interface PlatformContext

Returns:

A new UnsolicitedEventProcessor.

Throws:

RemoteServicesException - Thrown on error

getDirectoryContext

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

Description copied from interface: PlatformContext

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

Specified by:

getDirectoryContext in interface PlatformContext

Returns:

A non-null DirContext instance.

Throws:

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

setSubject

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

Description copied from interface: PlatformContext

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

Specified by:

setSubject in interface PlatformContext

Parameters:

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