com.sun.identity.sm

Class ServiceSchemaManager

java.lang.Object

com.sun.identity.sm.ServiceSchemaManager

public class ServiceSchemaManager
extends Object

The class ServiceSchemaManager provides interfaces to manage the service's schema. It provides access to ServiceSchema, which represents a single "schema" in the service.

Constructor Summary

Constructors

Constructor and Description
ServiceSchemaManager(SSOToken token, String serviceName, String version) Creates an instance of ServiceSchemaManager for the given service and version pair.
ServiceSchemaManager(String serviceName, SSOToken token) Constructor for service's schema manager to manage the attributes and sub configurations.

Method Summary

Modifier and Type	Method and Description
String	addListener(ServiceListener listener) Registers for changes to service's schema.
void	addPluginInterface(String interfaceName, String interfaceClass, String i18nKey) Adds a new plugin interface objct to service's schema.
boolean	equals(Object o) Returns true if the given object equals this object.
protected Document	getDocumentCopy()
ServiceSchema	getDynamicSchema() Returns the dynamic service configuration schema.
ServiceSchema	getGlobalSchema() Returns the global service configuration schema.
String	getI18NFileName() Returns the I18N properties file name for the service.
String	getI18NJarURL() Returns the URL of the JAR file that contains the I18N properties file.
String	getI18NKey() Returns i18nKey of the schema.
String	getLastModifiedTime() Returns the last modified time stamp of this service schema.
String	getName() Returns the name of the service.
ServiceSchema	getOrganizationCreationSchema() Returns the organization creation configuration schema if present; else returns null
ServiceSchema	getOrganizationSchema() Returns the organization service configuration schema.
PluginInterface	getPluginInterface(String pluginInterfaceName) Returns the PluginInterface object of the service for the specified plugin interface name
Set	getPluginInterfaceNames() Returns the names of the plugin interfaces used by the service
PluginSchema	getPluginSchema(String pluginSchemaName, String interfaceName, String orgName) Returns the PluginSchema object given the schema name and the interface name for the specified organization.
Set	getPluginSchemaNames(String interfaceName, String orgName) Returns the names of plugins configured for the plugin interface.
ServiceSchema	getPolicySchema() Returns the policy service configuration schema.
String	getPropertiesViewBeanURL() Returns URL of the view bean for the service
String	getResourceName() Returns the service's resource name for CREST representation, or the service name if a resource name is not defined.
int	getRevisionNumber() iPlanet_PUBLIC-METHOD Returns the revision number of the service schema.
InputStream	getSchema() Returns the service schema in XML for this service.
ServiceSchema	getSchema(SchemaType type) Returns the configuration schema for the given schema type
ServiceSchema	getSchema(String type) Returns the configuration schema for the given schema type
Set<SchemaType>	getSchemaTypes() Returns the schema types available with this service.
Set	getServiceAttributeNames(SchemaType type) Returns the attribute schemas for the given schema type excluding status and service identifier attributes.
String	getServiceHierarchy() Returns the service's hierarchy.
ServiceSchema	getUserSchema() Returns the user service configuration schema.
String	getVersion() Returns the version of the service.
int	hashCode()
boolean	isSSOTokenValid() Returns true if admin token cached within this class is valid
<E extends Exception> void	modifySchema(org.forgerock.util.Function<Document,Boolean,E> modifier)
void	removeListener(String listenerID) Removes the listener from the service for the given listener ID.
void	removePluginInterface(String interfacename) Removes the plugin interface object from the service schema.
protected void	replaceSchema(Document document)
void	replaceSchema(InputStream xmlServiceSchema) Replaces the existing service schema with the given schema defined by the XML input stream that follows the SMS DTD.
void	setI18NFileName(String url) Sets the I18N properties file name for the service
void	setI18NJarURL(String url) Sets the URL of the JAR file that contains the I18N properties
void	setI18NKey(String i18nKey) Sets the i18nKey of the schema.
void	setPropertiesViewBeanURL(String url) Sets the URL of the view bean for the service.
void	setResourceName(String name) Sets the service's resource name for CREST representation.
void	setRevisionNumber(int revisionNumber) iPlanet_PUBLIC-METHOD Sets the revision number for the service schema.
void	setServiceHierarchy(String newhierarchy) Sets the service's hierarchy
String	toString() Returns the string representation of the Service Schema.
String	toXML(AMEncryption encryptObj)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ServiceSchemaManager

public ServiceSchemaManager(String serviceName,
                            SSOToken token)
                     throws SMSException,
                            SSOException

Constructor for service's schema manager to manage the attributes and sub configurations. Assumes service version number to be 1.0 .

Throws:

SMSException - if an error occurred while trying to perform the operation

SSOException - if the single sign on token is invalid or expired

ServiceSchemaManager

public ServiceSchemaManager(SSOToken token,
                            String serviceName,
                            String version)
                     throws SMSException,
                            SSOException

Creates an instance of ServiceSchemaManager for the given service and version pair. It requires an user identity, that will used to perform operations with. It is assumed that the application calling this constructor should authenticate the user.

Parameters:

token - single sign on token of the user identity on whose behalf the operations are performed.

serviceName - the name of the service.

version - the version of the service.

Throws:

SMSException - if an error occurred while trying to perform the operation

SSOException - if the single sign on token is invalid or expired

Method Detail

getName

public String getName()

Returns the name of the service.

Returns:

the name of the service

getVersion

public String getVersion()

Returns the version of the service.

Returns:

the version of the service

getI18NFileName

public String getI18NFileName()

Returns the I18N properties file name for the service.

Returns:

the I18N properties file name for the service

setI18NFileName

public void setI18NFileName(String url)
                     throws SMSException,
                            SSOException

Sets the I18N properties file name for the service

Parameters:

url - properties file name

Throws:

SMSException - if an error occurred while trying to perform the operation

SSOException - if the single sign on token is invalid or expired

getI18NJarURL

public String getI18NJarURL()

Returns the URL of the JAR file that contains the I18N properties file. The method could return null, in which case the properties file should be in CLASSPATH.

Returns:

the URL of the JAR file containing the I18N properties file.

setI18NJarURL

public void setI18NJarURL(String url)
                   throws SMSException,
                          SSOException

Sets the URL of the JAR file that contains the I18N properties

Parameters:

url - URL

Throws:

SMSException - if an error occurred while trying to perform the operation

SSOException - if the single sign on token is invalid or expired

getServiceHierarchy

public String getServiceHierarchy()

Returns the service's hierarchy.

Returns:

service hierarchy in slash format.

setServiceHierarchy

public void setServiceHierarchy(String newhierarchy)
                         throws SMSException,
                                SSOException

Sets the service's hierarchy

Parameters:

newhierarchy - service hierarchy

Throws:

SMSException - if an error occurred while trying to perform the operation

SSOException - if the single sign on token is invalid or expired

getI18NKey

public String getI18NKey()

Returns i18nKey of the schema.

Returns:

i18nKey of the schema.

setI18NKey

public void setI18NKey(String i18nKey)
                throws SMSException,
                       SSOException

Sets the i18nKey of the schema.

Parameters:

i18nKey - i18nKey of the schema.

Throws:

SMSException - if an error occurred while trying to perform the operation.

SSOException - if the single sign on token is invalid or expired.

getPropertiesViewBeanURL

public String getPropertiesViewBeanURL()

Returns URL of the view bean for the service

Returns:

URL for view bean

setPropertiesViewBeanURL

public void setPropertiesViewBeanURL(String url)
                              throws SMSException,
                                     SSOException

Sets the URL of the view bean for the service.

Parameters:

url - of the view bean for the service.

Throws:

SMSException - if an error occurred while trying to perform the operation.

SSOException - if the single sign on token is invalid or expired.

getResourceName

public String getResourceName()

Returns the service's resource name for CREST representation, or the service name if a resource name is not defined.

setResourceName

public void setResourceName(String name)
                     throws SMSException,
                            SSOException

Sets the service's resource name for CREST representation.

Parameters:

name - resource name for CREST representation

Throws:

SMSException - if an error occurred while trying to perform the operation

SSOException - if the single sign on token is invalid or expired

getRevisionNumber

public int getRevisionNumber()

iPlanet_PUBLIC-METHOD Returns the revision number of the service schema.

Returns:

the revision number of the service schema

setRevisionNumber

public void setRevisionNumber(int revisionNumber)
                       throws SMSException,
                              SSOException

iPlanet_PUBLIC-METHOD Sets the revision number for the service schema.

Parameters:

revisionNumber - revision number of the service schema.

Throws:

SMSException - if there is a problem setting the value in the data store.

SSOException - If the user has an invalid SSO token.

getSchemaTypes

public Set<SchemaType> getSchemaTypes()
                               throws SMSException

Returns the schema types available with this service.

Returns:

set of SchemaTypes in this service.

Throws:

SMSException - if an error occurred while trying to perform the operation

getSchema

public ServiceSchema getSchema(String type)
                        throws SMSException

Returns the configuration schema for the given schema type

Parameters:

type - schema type.

Returns:

service schema.

Throws:

SMSException - if an error occurred while trying to perform the operation

getSchema

public ServiceSchema getSchema(SchemaType type)
                        throws SMSException

Returns the configuration schema for the given schema type

Parameters:

type - schema type.

Returns:

service schema.

Throws:

SMSException - if an error occurred while trying to perform the operation

getOrganizationCreationSchema

public ServiceSchema getOrganizationCreationSchema()
                                            throws SMSException

Returns the organization creation configuration schema if present; else returns null

Returns:

service schema.

Throws:

SMSException - if an error occurred while trying to perform the operation

getServiceAttributeNames

public Set getServiceAttributeNames(SchemaType type)
                             throws SMSException

Returns the attribute schemas for the given schema type excluding status and service identifier attributes.

Parameters:

type - schema type.

Returns:

service schema.

Throws:

SMSException - if an error occurred while trying to perform the operation

getGlobalSchema

public ServiceSchema getGlobalSchema()
                              throws SMSException

Returns the global service configuration schema.

Returns:

the global service configuration schema

Throws:

SMSException - if an error occurred while trying to perform the operation

getOrganizationSchema

public ServiceSchema getOrganizationSchema()
                                    throws SMSException

Returns the organization service configuration schema.

Returns:

the organization service configuration schema

Throws:

SMSException - if an error occurred while trying to perform the operation

getDynamicSchema

public ServiceSchema getDynamicSchema()
                               throws SMSException

Returns the dynamic service configuration schema.

Returns:

the dynamic service configuration schema

Throws:

SMSException - if an error occurred while trying to perform the operation

getUserSchema

public ServiceSchema getUserSchema()
                            throws SMSException

Returns the user service configuration schema.

Returns:

the user service configuration schema

Throws:

SMSException - if an error occurred while trying to perform the operation

getPolicySchema

public ServiceSchema getPolicySchema()
                              throws SMSException

Returns the policy service configuration schema.

Returns:

the policy service configuration schema

Throws:

SMSException - if an error occurred while trying to perform the operation

getSchema

public InputStream getSchema()
                      throws SMSException

Returns the service schema in XML for this service.

Returns:

the service schema in XML for this service

Throws:

SMSException - if an error occurred while trying to perform the operation

replaceSchema

public void replaceSchema(InputStream xmlServiceSchema)
                   throws SSOException,
                          SMSException,
                          IOException

Replaces the existing service schema with the given schema defined by the XML input stream that follows the SMS DTD.

Parameters:

xmlServiceSchema - the XML format of the service schema

Throws:

SMSException - if an error occurred while trying to perform the operation

SSOException - if the single sign on token is invalid or expired

IOException - if an error occurred with the InputStream

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Returns true if the given object equals this object.

Overrides:

equals in class Object

Parameters:

o - object for comparison.

Returns:

true if the given object equals this object.

toString

public String toString()

Returns the string representation of the Service Schema.

Overrides:

toString in class Object

Returns:

the string representation of the Service Schema.

addListener

public String addListener(ServiceListener listener)

Registers for changes to service's schema. The object will be called when schema for this service and version is changed.

Parameters:

listener - callback object that will be invoked when schema changes.

Returns:

an ID of the registered listener.

removeListener

public void removeListener(String listenerID)

Removes the listener from the service for the given listener ID. The ID was issued when the listener was registered.

Parameters:

listenerID - the listener ID issued when the listener was registered

getLastModifiedTime

public String getLastModifiedTime()
                           throws SMSException,
                                  SSOException

Returns the last modified time stamp of this service schema. 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

Returns:

The last modified time stamp as a string with the format of yyyyMMddhhmmss

Throws:

SMSException - if there is an error trying to read from the datastore.

SSOException - if the single sign-on token of the user is invalid.

getPluginInterfaceNames

public Set getPluginInterfaceNames()

Returns the names of the plugin interfaces used by the service

Returns:

service's plugin interface names

getPluginInterface

public PluginInterface getPluginInterface(String pluginInterfaceName)

Returns the PluginInterface object of the service for the specified plugin interface name

Parameters:

pluginInterfaceName - name of the plugin interface

Returns:

plugin interface configured for the service; else null

addPluginInterface

public void addPluginInterface(String interfaceName,
                               String interfaceClass,
                               String i18nKey)
                        throws SMSException,
                               SSOException

Adds a new plugin interface objct to service's schema.

Parameters:

interfaceName - name for the plugin interface

interfaceClass - fully qualified interface class name

i18nKey - I18N key that will by used by UI to get messages to display the interface name

Throws:

SMSException

SSOException

removePluginInterface

public void removePluginInterface(String interfacename)
                           throws SMSException,
                                  SSOException

Removes the plugin interface object from the service schema.

Parameters:

interfacename - Name of the plugin class.

Throws:

SMSException

SSOException

getPluginSchemaNames

public Set getPluginSchemaNames(String interfaceName,
                                String orgName)
                         throws SMSException

Returns the names of plugins configured for the plugin interface. If organization is null, returns the plugins configured for the "root" organization.

Throws:

SMSException

getPluginSchema

public PluginSchema getPluginSchema(String pluginSchemaName,
                                    String interfaceName,
                                    String orgName)
                             throws SMSException

Returns the PluginSchema object given the schema name and the interface name for the specified organization. If organization is null, returns the PluginSchema for the "root" organization.

Throws:

SMSException

isSSOTokenValid

public boolean isSSOTokenValid()

Returns true if admin token cached within this class is valid

Returns:

true is admin token is valid

getDocumentCopy

protected Document getDocumentCopy()
                            throws SMSException

Throws:

SMSException

replaceSchema

protected void replaceSchema(Document document)
                      throws SSOException,
                             SMSException

Throws:

SSOException

SMSException

modifySchema

public <E extends Exception> void modifySchema(org.forgerock.util.Function<Document,Boolean,E> modifier)
                                        throws E extends Exception,
                                               SMSException,
                                               SSOException

Throws:

E extends Exception

SMSException

SSOException

toXML

public String toXML(AMEncryption encryptObj)
             throws SMSException

Throws:

SMSException