EASP API 7.13.0

net.juniper.smgt.ent.im
Class ServiceProviderFactory

java.lang.Object
  extended by net.juniper.smgt.ent.im.ServiceProviderFactory

public class ServiceProviderFactory
extends java.lang.Object

The static methods of this factory class are the initial point of access to the SSC Enterprise Portal API. Developers must use this factory to obtain a new ServiceProvider instance, and pass to that ServiceProvider's bind method a principal (i.e. an optionally qualified login ID) and a password. This binds the ServiceProvider instance to a paraticular Manager defined in the SSC's LDAP directory. The ServiceProvider instance will then provide access to everything that the Manager with the specified login ID and password is allowed to manipulate.


Method Summary
static java.util.Set getAllServiceProviders()
          Returns all ServiceProvider instances that have not been garbage collected.
static ServiceProvider getServiceProvider()
          Returns a new ServiceProvider which is not yet bound to any Manager.
static java.util.List getServiceProviderById(java.lang.String fullyQualifiedPrincipal)
          Returns a list of ServiceProvider instances that have been bound to fullyQualifiedPrincipal via a previous call to ServiceProvider.bind(String, String), and that have not since been unbound via a call to ServiceProvider.unbind(), and that have not been garbage collected.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getServiceProvider

public static ServiceProvider getServiceProvider()
                                          throws MisconfigurationException,
                                                 java.lang.IllegalStateException
Returns a new ServiceProvider which is not yet bound to any Manager. Use ServiceProvider.bind(String, String) to bind it.

Returns:
An unbound ServiceProvider instance.
Throws:
MisconfigurationException - Thrown if the property "net.juniper.smgt.ent.ServiceProviderClassName" names a class that isn't in the classpath or can't be instantiated as a ServiceProvider.
java.lang.IllegalStateException - Thrown if the enterprise portal server has not yet completed its start-up initialization.
See Also:
Manager

getAllServiceProviders

public static java.util.Set getAllServiceProviders()
Returns all ServiceProvider instances that have not been garbage collected. This feature is used for developing administrative portals that allow service provider employees to check existing and recently expired manager sessions. Warning: The ServiceProviders returned by this method will not be garbage collected until the caller of this method releases its references to them.

Returns:
The set of ServiceProvider instances that currently exist in the enterprise portal server's Java virtual machine.

getServiceProviderById

public static java.util.List getServiceProviderById(java.lang.String fullyQualifiedPrincipal)
Returns a list of ServiceProvider instances that have been bound to fullyQualifiedPrincipal via a previous call to ServiceProvider.bind(String, String), and that have not since been unbound via a call to ServiceProvider.unbind(), and that have not been garbage collected. Returns null if there is no such ServiceProvider. This feature is used for developing administrative portals that allow service provider employees to check existing and recently expired manager sessions. Warning: The ServiceProviders returned by this method will not be garbage collected until the caller of this method releases its references to them.

Parameters:
fullyQualifiedPrincipal - The fully qualified version of the principal that was passed to the bind method of the desired set of ServiceProviders.
Returns:
The ServiceProviders that are currently bound using the specified principal.
See Also:
ServiceProvider.bind(String,String), ServiceProvider.unbind()

EASP API 7.13.0