| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--com.sun.identity.sm.ServiceManager
The ServiceManager class provides methods to register/remove
 services and to list currently registered services. It also provides
 methods to obtain an instance of ServiceSchemaManager
 and an instance of ServiceConfigManager.
| Constructor Summary | |
| ServiceManager(SSOToken token)Creates an instance of ServiceManager. | |
| Method Summary | |
|  void | clearCache()Removes all the SMS cached entries. | 
|  ServiceConfigManager | getConfigManager(java.lang.String serviceName,
                 java.lang.String version)Returns the ServiceConfigManagerfor the given
 service name and version. | 
|  ServiceSchemaManager | getSchemaManager(java.lang.String serviceName,
                 java.lang.String version)Returns the ServiceSchemaManagerfor the given
 service name and version. | 
|  java.util.Set | getServiceNames()Returns all the service names that have been registered. | 
|  java.util.Set | getServiceVersions(java.lang.String serviceName)Returns all versions supported by the service. | 
| static boolean | isRealmEnabled()Returns trueif current service configuration
 uses the realm model to store the configuration data. | 
|  java.util.Set | registerServices(java.io.InputStream xmlServiceSchema)Registers one or more services, defined by the XML input stream that follows the SMS DTD. | 
|  void | removeService(java.lang.String serviceName,
              java.lang.String version)Removes the service schema and configuration for the given service name. | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
public ServiceManager(SSOToken token)
               throws SSOException,
                      SMSException
ServiceManager. The
 SSOToken is used to identify the user performing
 service operations.token - the authenticated single sign on token.SSOException - if the user's single sign on token is invalid or expiredSMSException - if an error occurred while performing the operation| Method Detail | 
public ServiceSchemaManager getSchemaManager(java.lang.String serviceName,
                                             java.lang.String version)
                                      throws SMSException,
                                             SSOException
ServiceSchemaManager for the given
 service name and version.serviceName - the name of the serviceversion - the version of the serviceServiceSchemaManager for the given service
	 name and versionSSOException - if the user's single sign on token is invalid or expiredSMSException - if an error occurred while performing the operation
public ServiceConfigManager getConfigManager(java.lang.String serviceName,
                                             java.lang.String version)
                                      throws SMSException,
                                             SSOException
ServiceConfigManager for the given
 service name and version.serviceName - the name of the serviceversion - the version of the serviceServiceConfigManager for the given service
	       name and version.SSOException - if the user's single sign on token is invalid or
         expiredSMSException - if an error occurred while performing the operation
public java.util.Set getServiceNames()
                              throws SMSException
SMSException - if an error occurred while performing the operation
public java.util.Set getServiceVersions(java.lang.String serviceName)
                                 throws SMSException
serviceName - service name.SMSException - if an error occurred while performing the operation
public java.util.Set registerServices(java.io.InputStream xmlServiceSchema)
                               throws SMSException,
                                      SSOException
xmlServiceSchema - the input stream of service metadata in XML
        conforming to SMS DTD.SMSException - if an error occurred while performing the operationSSOException - if the user's single sign on token is invalid or expired
public void removeService(java.lang.String serviceName,
                          java.lang.String version)
                   throws SMSException,
                          SSOException
serviceName - the name of the serviceversion - the version of the serviceSMSException - if an error occurred while performing the operationSSOException - if the user's single sign on token is invalid or expiredpublic void clearCache()
public static boolean isRealmEnabled()
true if current service configuration
 uses the realm model to store the configuration data.true is realm model is used for storing
 configuration data; false otherwise.| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||