Uses of Class
com.sun.identity.sm.SMSException

Packages that use SMSException

Package	Description
com.sun.identity.sm	Provides classes for accessing the Service Management Service (SMS).
org.forgerock.openam.secrets	The AM supporting classes for centrally configuring secrets.
org.forgerock.openam.sm	This package contains exception types for service management error scenarios.

Uses of SMSException in com.sun.identity.sm

Subclasses of SMSException in com.sun.identity.sm

Modifier and Type	Class	Description
class	InvalidAttributeNameException	The InvalidAttributeNameException is thrown to indicate that an invalid attribute name was used.
class	InvalidAttributeValueException
class	OrganizationAlreadyExistsException	The OrganizationAlreadyExistsException is thrown if the organization already exists.
class	SchemaException	The SchemaException is thrown if the error encountered is related to the schema.
class	ServiceAlreadyExistsException	The ServiceAlreadyExistsException is thrown if the service already exists.
class	ServiceNotFoundException	The ServiceNotFoundException is thrown if the service does not exist.

Methods in com.sun.identity.sm that throw SMSException

Modifier and Type	Method	Description
void	ServiceConfig.addAttribute(String attrName, Set<String> values)	Adds a configuration parameter to the service configuration.
void	ServiceInstance.addAttribute(String attrName, Set<String> values)	Adds the given attribute name and values to the attribute set.
void	ServiceSchema.addAttributeSchema(InputStream xmlAttrSchema)	Adds the attribute schema to this service.
void	OrganizationConfigManager.addAttributeValues(String serviceName, String attrName, Set<String> values)	Adds organization attributes for the service.
void	AttributeSchema.addChoiceValue(String value, String i18nKey)	Adds a choice value and its i18n key to the existing set of choice values.
void	ServiceConfigManager.addConfiguration(InputStream in)	Adds instances, global and organization configurations
void	AttributeSchema.addDefaultValue(String value)	Adds a default value to the existing set of default values.
void	ServiceConfig.addExportedOrganizationNames(Set<String> names)	Adds the organization names to the list of organization names that can import this service configutation.
ServiceConfig	OrganizationConfigManager.addServiceConfig(String serviceName, org.forgerock.openam.sm.ConfigurationAttributes attributes)	Adds a service configuration object for the given service name for this organization.
void	ServiceConfig.addSubConfig(String subConfigName, String subConfigId, int priority, org.forgerock.openam.sm.ConfigurationAttributes attrs)	Adds a service sub-configuration with configuration parameters.
void	ServiceConfig.addSubConfig(String subConfigName, String subConfigId, int priority, org.forgerock.openam.sm.ConfigurationAttributes attrs, boolean isNewRealm)	Adds a service sub-configuration with configuration parameters.
void	ServiceConfig.addSubConfig(String subConfigName, String subConfigId, org.forgerock.openam.sm.ConfigurationAttributes attrs)	Adds a service sub-configuration with configuration parameters.
void	ServiceSchema.addSubSchema(InputStream xmlSubSchema)	Adds the service's sub-schema given the XML input stream that follows the SMS DTD.
void	ServiceSchema.addSubSchema(Document xmlSubSchema)	Adds the service's sub-schema given the XML document that follows the SMS DTD.
void	OrganizationConfigManager.assignService(String serviceName, org.forgerock.openam.sm.ConfigurationAttributes attributes)	Assigns the given service to the orgnization with the respective attributes.
void	ServiceConfig.checkAndCreateGroup(String dn, String groupName, org.forgerock.openam.services.datastore.DataStoreId dataStoreId)
ServiceConfig	ServiceConfigManager.createGlobalConfig(Map<String,Set<String>> attrs)	Creates global configuration for the default instance of the service given the configuration attributes.
ServiceConfig	ServiceConfigManager.createGlobalConfig(Map<String,Set<String>> attrs, org.forgerock.openam.services.datastore.DataStoreId dataStoreId)	Creates global configuration for the default instance of the service given the configuration attributes.
ServiceConfig	ServiceConfigManager.createOrganizationConfig(String orgName, org.forgerock.openam.sm.ConfigurationAttributes attrs, org.forgerock.openam.services.datastore.DataStoreId dataStoreId)	Creates organization configuration for the default instance of the service given configuration attributes.
OrganizationConfigManager	OrganizationConfigManager.createSubOrganization(String subOrgName, Map<String,?> attributes)	Creates a sub-organization under the current organization and sets the specified attributes.
OrganizationConfigManager	OrganizationConfigManager.createSubOrganization(String subOrgName, org.forgerock.openam.services.datastore.DataStoreId dataStoreId)	Creates a sub-organization under the current organization, without any child entries.
void	ServiceConfig.deleteLabeledUri(String luri)	Deprecated. The labeledURI setting shall not be used for storing configuration data.
void	ServiceConfigManager.deleteOrganizationConfig(String orgName)	Deletes the organization configuration data for the given organization.
void	OrganizationConfigManager.deleteSubOrganization(String subOrgName, boolean recursive)	Deletes the given sub-organization.
Set<String>	OrganizationConfigManager.getAssignableServices()	Returns a set of service names that can be assigned to a realm.
Set<String>	OrganizationConfigManager.getAssignedServices()	Returns a set of service names that are assigned to a realm.
Set<String>	OrganizationConfigManager.getAssignedServices(boolean includeMandatory)	Returns a set of service names that are assigned to a realm.
Map<String,Set<String>>	OrganizationConfigManager.getAttributes(String serviceName)	Returns the organization creation attributes for the service.
ServiceConfigManager	ServiceManager.getConfigManager(String serviceName, String version)	Returns the ServiceConfigManager for the given service name and version.
Set<String>	OrganizationConfigManager.getConfiguredServices()	Deprecated. This method has been deprecated, use getAssignedServices() instead.
ServiceSchema	ServiceSchemaManager.getDynamicSchema()	Returns the dynamic service configuration schema.
Set<String>	ServiceConfig.getExportedSubConfigNames(String serviceId)	Returns a set of exported fully qualified sub-configuration names that can be imported used locally as service configuration
ServiceConfig	ServiceConfigManager.getGlobalConfig(String instanceName)	Returns the global configuration for the given service instance.
ServiceConfig	ServiceConfigManager.getGlobalConfig(String instanceName, org.forgerock.openam.services.datastore.DataStoreId dataStoreId)	Returns the global configuration for the given service instance.
ServiceSchema	ServiceSchemaManager.getGlobalSchema()	Returns the global service configuration schema.
Set<String>	ServiceConfigManager.getGroupNames()	Returns the configuration group names
ServiceInstance	ServiceConfigManager.getInstance(String instanceName)	Returns the service instance given the instance name
Set<String>	ServiceConfigManager.getInstanceNames()	Returns the service instance names
Set<String>	ServiceConfigManager.getInstanceNames(org.forgerock.openam.services.datastore.DataStoreId dataStoreId)
String	ServiceConfig.getLastModifiedTime()	Returns the last modified time stamp of this configuration This method is expensive because it does not cache the modified time stamp but goes directly to the data store to obtain the value of this entry
ServiceConfig	ServiceConfigManager.getOrganizationConfig(String orgName, String instanceName)	Returns the organization configuration for the given organization and instance name.
ServiceConfig	ServiceConfigManager.getOrganizationConfig(String orgName, String instanceName, org.forgerock.openam.services.datastore.DataStoreId dataStoreId)	Returns the organization configuration for the given organization and instance name.
ServiceSchema	ServiceSchemaManager.getOrganizationSchema()	Returns the organization service configuration schema.
OrganizationConfigManager	OrganizationConfigManager.getParentOrgConfigManager()	Returns the OrganizationConfigManager of the parent for the given organization name.
Set<String>	OrganizationConfigManager.getPeerOrganizationNames()	Returns the names of all peer-organizations.
ServiceSchema	ServiceSchemaManager.getPolicySchema()	Returns the policy service configuration schema.
InputStream	ServiceSchemaManager.getSchema()	Returns the service schema in XML for this service.
ServiceSchema	ServiceSchemaManager.getSchema(SchemaType type)	Returns the configuration schema for the given schema type
ServiceSchema	ServiceSchemaManager.getSchema(String type)	Returns the configuration schema for the given schema type
ServiceSchemaManager	ServiceManager.getSchemaManager(String serviceName, String version)	Returns the ServiceSchemaManager for the given service name and version.
Set<SchemaType>	ServiceSchemaManager.getSchemaTypes()	Returns the schema types available with this service.
Set<String>	ServiceSchemaManager.getServiceAttributeNames(SchemaType type)	Returns the attribute schemas for the given schema type excluding status and service identifier attributes.
Map<String,Set<String>>	OrganizationConfigManager.getServiceAttributes(String serviceName)	Returns attributes configured for the service.
ServiceConfig	OrganizationConfigManager.getServiceConfig(String serviceName)	Returns the service configuration object for the given service name.
Set<String>	ServiceManager.getServiceNames()	Returns all the service names that have been registered.
Set<ServiceSchema>	OrganizationConfigManager.getServiceSchemas()	Returns a set of service schemas to be used for creation of an organization.
Set<String>	ServiceManager.getServiceVersions(String serviceName)	Returns all versions supported by the service.
ServiceConfig	ServiceConfig.getSubConfig(String subConfigName)	Returns the service's sub-configuration given the service's sub-configuration name.
Map<String,Set<String>>	ServiceConfig.getSubConfigEntity(String entityName)	Method to retrieve a single service sub-configuration entry by name.
Set<String>	ServiceConfig.getSubConfigNames()	Returns the names of all service's sub-configurations.
Set<String>	ServiceConfig.getSubConfigNames(String pattern)	Method to get names of service's sub-configurations that match the given pattern.
Set<String>	ServiceConfig.getSubConfigNames(String pattern, String schemaName)	Method to get names of service's sub-configurations that match the given pattern and belongs to the specified service schema name.
Set<String>	OrganizationConfigManager.getSubOrganizationNames()	Returns the names of all sub-organizations.
Set<String>	OrganizationConfigManager.getSubOrganizationNames(String pattern, boolean recursive)	Returns names of sub-organizations matching the given pattern.
Set<String>	OrganizationConfigManager.getSubOrganizationNames(String pattern, boolean recursive, org.forgerock.openam.services.datastore.DataStoreId dataStoreId)	Returns names of sub-organizations matching the given pattern.
OrganizationConfigManager	OrganizationConfigManager.getSubOrgConfigManager(String subOrgName)	Returns the OrganizationConfigManager for the given organization name.
ServiceSchema	ServiceSchema.getSubSchema(String subSchemaName)	Returns ServiceSchema object given the name of the service's sub-schema.
ServiceSchema	ServiceSchemaManager.getUserSchema()	Returns the user service configuration schema.
void	ServiceConfig.importSubConfig(String subConfigName, String exportedSubConfigName)	Imports a service sub-configuration to the list of localy defined sub-configuration.
boolean	ServiceConfig.isAttributePresentInSubConfigs(String attributeName, String attributeValue, String... subSchemaNamesToSearchIn)	Checks whether a config attribute value exists in any of this ServiceConfig's sub-configurations.
static void	OrganizationConfigManager.loadDefaultServices(OrganizationConfigManager ocm)	Loads default services to a newly created realm
void	OrganizationConfigManager.modifyService(String serviceName, org.forgerock.openam.sm.ConfigurationAttributes attributes)	Sets the attributes related to provided service.
Set<String>	ServiceManager.registerServices(InputStream xmlServiceSchema)	Registers one or more services, defined by the XML input stream that follows the SMS DTD.
void	OrganizationConfigManager.removeAttribute(String serviceName, String attrName)	Removes the given organization creation attribute for the service.
void	ServiceConfig.removeAttribute(String attrName)	Removes a configuration parameter from the service configuration.
void	ServiceInstance.removeAttribute(String attrName)	Removes the specified attribute name and its values from the attribute set.
void	ServiceSchema.removeAttributeDefaults(Set<String> attrs)	Removes the default values of attributes in the schema.
void	ServiceConfig.removeAttributes(Set<String> attrNames)	Removes a configuration parameters from the service configuration.
void	ServiceSchema.removeAttributeSchema(String attrName)	Removes the attribute schema from this service.
void	OrganizationConfigManager.removeAttributeValues(String serviceName, String attrName, Set<String> values)	Removes the given organization creation attribute values for the service.
void	ServiceConfig.removeAttributeValues(String attrName, Set<String> values)	Removes the specific values for the given configuration parameter.
void	ServiceInstance.removeAttributeValues(String attrName, Set<String> values)	Removes the specified attribute's values.
void	AttributeSchema.removeChoiceValue(String value)	Removes the given value from the set of choice values.
void	AttributeSchema.removeDefaultValue(String value)	Removes the given value from the set of default values.
void	AttributeSchema.removeDefaultValues()	Removes the all the default values for the attribute.
void	ServiceConfigManager.removeGlobalConfiguration(String groupName)	Deletes the global configuration data for the given group name.
void	ServiceConfigManager.removeInstance(String instanceName)	Removes the instance form the service
void	ServiceConfigManager.removeOrganizationConfiguration(String orgName, String groupName)	Deprecated.
void	ServiceConfigManager.removeOrganizationConfiguration(String orgName, String groupName, org.forgerock.openam.services.datastore.DataStoreId dataStoreId)	Deletes the organization's group configuration data.
void	ServiceManager.removeService(String serviceName, String version)	Removes the service schema and configuration for the given service name.
void	OrganizationConfigManager.removeServiceConfig(String serviceName)	Removes the service configuration object for the given service name for this organization.
void	ServiceConfig.removeSharedOrganizationNames(Set<String> names)	Removes the organization names from the list of organization names that can import the service configuration.
void	ServiceConfig.removeSubConfig(String subConfigName)	Removes the service sub-configuration.
void	ServiceSchema.removeSubSchema(String subSchemaName)	Removes the service's sub-schema from the service.
void	ServiceSchema.replaceAttributeSchema(String attrName, Node attributeSchemaNode)	Removes the attribute schema from this service.
void	ServiceConfig.replaceAttributeValue(String attrName, String oldValue, String newValue)	Replaces old value of the configuration parameter with new value.
void	ServiceInstance.replaceAttributeValue(String attrName, String oldValue, String newValue)	Replaces the attribute's old value with the new value.
void	ServiceConfig.replaceAttributeValues(String attrName, Set<String> oldValues, Set<String> newValues)	Replaces the old values of the configuration parameter with the new values.
void	ServiceInstance.replaceAttributeValues(String attrName, Set<String> oldValues, Set<String> newValues)	Replaces the attribute's old values with the new values
void	ServiceSchemaManager.replaceSchema(InputStream xmlServiceSchema)	Replaces the existing service schema with the given schema defined by the XML input stream that follows the SMS DTD.
void	ServiceSchema.replaceSubSchema(String subSchemaName, Document xmlSubSchema)	Replaces the service's sub-schema given the XML document that follows the SMS DTD.
void	AttributeSchema.setAny(String a)	Sets the any attribute.
void	OrganizationConfigManager.setAttributes(String serviceName, Map<String,Set<String>> attributes)	Sets/Creates organization attributes for the service.
void	ServiceConfig.setAttributes(Map attrs)
void	ServiceConfig.setAttributes(org.forgerock.openam.sm.ConfigurationAttributes attrs)	Sets the service configuration parameters.
void	ServiceInstance.setAttributes(org.forgerock.openam.sm.ConfigurationAttributes attrs)	Sets the attributes that are specific to the service instance.
void	AttributeSchema.setBooleanValues(String trueValue, String trueValueI18nKey, String falseValue, String falseValueI18nKey)	Sets the boolean values of the attribute.
void	AttributeSchema.setCosQualifier(String cosq)	Sets the cosQualifier attribute
void	AttributeSchema.setDefaultValues(Set<String> values)	Sets the default values of the attribute.
void	AttributeSchema.setEndRange(String edRange)	Sets the end range Attribute.
void	ServiceConfig.setExportedOrganizationNames(Set<String> names)	Sets the organization names that can import the service configuration.
void	ServiceInstance.setGroup(String groupName)	Sets the group name for this instance.
void	ServiceSchema.setI18NFileName(String url)	Sets the I18N properties file name for the service schema
void	ServiceSchemaManager.setI18NFileName(String url)	Sets the I18N properties file name for the service
void	ServiceSchemaManager.setI18NJarURL(String url)	Sets the URL of the JAR file that contains the I18N properties
void	ServiceSchema.setI18Nkey(String key)	Sets the value of the I18N key in the service schema.
void	AttributeSchema.setI18NKey(String i18nKey)	Sets the I18N key to describe the configuration attribute.
void	ServiceSchemaManager.setI18NKey(String i18nKey)	Sets the i18nKey of the schema.
void	ServiceSchema.setInheritance(String value)	Set the value of inheritance attribute in service schema.
void	ServiceConfig.setLabeledUri(String luri)	Deprecated. The labeledURI setting shall not be used for storing configuration data.
void	AttributeSchema.setMaxValue(String maxV)	Sets the maximum value attribute.
void	AttributeSchema.setMinValue(String minV)	Sets the minimum value attribute.
void	AttributeSchema.setOrder(Integer order)	Sets the order of this attribute.
void	ServiceConfig.setPriority(int priority)	Sets the priority to the service configuration.
void	AttributeSchema.setPropertiesViewBeanUR(String prop)	Sets the URL of the view bean for the attribute.
void	ServiceSchemaManager.setPropertiesViewBeanURL(String url)	Sets the URL of the view bean for the service.
void	AttributeSchema.setResourceName(String name)	Sets the CREST representation name for the attribute.
void	ServiceSchema.setResourceName(String name)	Sets the CREST resource name for the service schema.
void	ServiceSchemaManager.setResourceName(String name)	Sets the service's resource name for CREST representation.
void	AttributeSchema.setSearchable(String value)	Sets the attribute isSearchable, if value is set to true , or false.
void	ServiceSchemaManager.setServiceHierarchy(String newhierarchy)	Sets the service's hierarchy
void	AttributeSchema.setStartRange(String stRange)	Sets the start range attribute.
void	AttributeSchema.setSyntax(String synt)	Sets the Syntax attribute.
void	AttributeSchema.setType(String type)	Sets the type.
void	AttributeSchema.setUIType(String uiType)	Sets the UIType attribute.
void	ServiceInstance.setURI(String uri)	Sets the URI for the service instance.
void	AttributeSchema.setValidator(String valid)	Sets the Validator attribute
String	ServiceConfig.toXML(String NodeTag, com.iplanet.services.util.AMEncryption encryptObj)
String	ServiceConfig.toXML(String NodeTag, com.iplanet.services.util.AMEncryption encryptObj, String orgName)
void	OrganizationConfigManager.unassignService(String serviceName)	Unassigns the service from the organization.
protected void	AttributeSchema.updateBooleanValues(String trueValue, String trueValueI18nKey, String falseValue, String falseValueI18nKey, Document doc)
protected void	AttributeSchema.updateChoiceValues(Map<String,String> choiceValues)
protected void	AttributeSchema.updateChoiceValues(Map<String,String> choiceValues, Document doc)
protected void	AttributeSchema.updateDefaultValues(Set<String> defaultValues)	Method for modifying default values
protected void	AttributeSchema.updateDefaultValues(Set<String> defaultValues, Document doc)	Method for modifying default values given the XML document
protected void	AttributeSchema.updateXMLDocument(StringBuffer sb, String elementName, Document updateDoc)
protected void	AttributeSchema.updateXMLDocument(String attrName, String attrValue)	update attribute value in attribute schema element
org.forgerock.openam.sm.ConfigurationAttributes	ServiceSchema.validateAndInheritDefaults(org.forgerock.openam.sm.ConfigurationAttributes attrMap, boolean inherit, org.forgerock.openam.sm.ConfigurationAttributes defaults)	Validates the attrMap against the attributes defined in this schema of the service.
org.forgerock.openam.sm.ConfigurationAttributes	ServiceSchema.validateAndInheritDefaults(org.forgerock.openam.sm.ConfigurationAttributes attrMap, String orgName, boolean inherit, org.forgerock.openam.sm.ConfigurationAttributes defaults)	Validates the attrMap against the attributes defined in this schema of the service for the given organization.
boolean	ServiceSchema.validateAttributes(List<String> configPath, Map<String,Set<String>> attributeSet)	Determines whether each attribute in the attribute set is valid.
boolean	ServiceSchema.validateAttributes(List<String> configPath, Map<String,Set<String>> attributeSet, String orgName)	Determines whether each attribute in the attribute set is valid for the given organization.
boolean	ServiceSchema.validateAttributes(Map<String,Set<String>> attributeSet)	Determines whether each attribute in the attribute set is valid.
boolean	ServiceSchema.validateAttributes(Map<String,Set<String>> attributeSet, String orgName)	Determines whether each attribute in the attribute set is valid for the given organization.
boolean	ServiceSchema.validateAttributes(Map<String,Set<String>> attributeSet, String orgName, boolean encodePassword)	Determines whether each attribute in the attribute set is valid for the given organization.
void	OrganizationConfigManager.validateOrgAliasCollision(Collection<String> aliases)	Checks org alias name for collisions
protected void	ServiceInstance.validateServiceInstance()

Constructors in com.sun.identity.sm that throw SMSException

Modifier	Constructor	Description
	OrganizationConfigManager(SSOToken token, String orgName)	Constructor to obtain an instance of OrganizationConfigManager for an organization by providing an authenticated identity of the user.
	ServiceConfigManager(SSOToken token, String serviceName, String version)	Creates an instance of ServiceConfigManager for the given service and version.
	ServiceManager(SSOToken token)	Creates an instance of ServiceManager.
	ServiceSchemaManager(SSOToken token, String serviceName, String version, org.forgerock.openam.services.datastore.DataStoreId dataStoreId, boolean isSaved)	Creates an instance of ServiceSchemaManager for the given service and version pair.

Uses of SMSException in org.forgerock.openam.secrets

Methods in org.forgerock.openam.secrets that throw SMSException

Modifier and Type	Method	Description
static void	SecretsUtils.createKeyStorePurposeMapping(org.forgerock.openam.secrets.config.SecretIdRegistry secretIdRegistry, org.forgerock.openam.secrets.config.KeyStoreSecretStore keyStore, String purposeLabel, List<String> aliases, Optional<Realm> realm, SSOToken authorizationToken)	Creates a global purpose and adds a mapping for it to the given key alias in the given keystore.
static org.forgerock.openam.secrets.config.KeyStoreSecretStore	SecretsUtils.getDefaultKeyStore(AnnotatedServiceRegistry serviceRegistry)	Gets the default keystore from the global scope.

Uses of SMSException in org.forgerock.openam.sm

Subclasses of SMSException in org.forgerock.openam.sm

Modifier and Type	Class	Description
class	ServiceConfigException	A sub-exception of SMSException for the ServiceConfigValidator.
class	ServiceErrorException	A sub-exception of SMSException for the ServiceConfigValidator.