com.sun.identity.sm
Class ServiceSchema

java.lang.Object
  |
  +--com.sun.identity.sm.ServiceSchema

public class ServiceSchema

extends java.lang.Object

The class ServiceSchema provides interfaces to manage the schema information of a service. The schema for a service can be one of the following types: GLOBAL, ORGANIZATION, DYNAMIC, USER, and POLICY.

Method Summary

void	addAttributeSchema(java.io.InputStream xmlAttrSchema) Adds the attribute schema to this service.
void	addSubSchema(java.io.InputStream xmlSubSchema) Adds the service's sub-schema given the XML inputstream that follows the SMS DTD.
java.util.Map	getAttributeDefaults() Get a map of all the attribute and their default values in this schema
AttributeSchema	getAttributeSchema(java.lang.String attributeName) Returns the schema for an attribute given the name of the attribute, defined for this service.
java.util.Set	getAttributeSchemaNames() Returns the names of the schema attributes defined for the service.
java.util.Set	getAttributeSchemas() Returns the attribute schemas defined for the service.
java.lang.String	getI18NKey() Returns the I18N key that points to the description of the service.
java.lang.String	getName() Returns the name of the schema.
java.lang.String	getPropertiesViewBeanURL() Returns the view bean URL for this service
java.util.Map	getReadOnlyAttributeDefaults() Get an unmodifiable map of all the attribute and their default values in this schema.
org.w3c.dom.Node	getSchemaNode() Returns the Node of this schema element.
java.util.Set	getServiceAttributeNames() Returns the attribute schemas defined for the service that is not a status attribute and is not a service attribute.
java.lang.String	getServiceName() Returns the name of the service.
SchemaType	getServiceType() Returns the schema tyoe
ServiceSchema	getSubSchema(java.lang.String subSchemaName) Returns ServiceSchema object given the name of the service's sub-schema.
java.util.Set	getSubSchemaNames() Returns the names of sub-schemas for the service.
java.lang.String	getVersion() Returns the version of the service.
void	removeAttributeDefaults(java.util.Set attrs) Removes the default values of attributes in the schema.
void	removeAttributeSchema(java.lang.String attrName) Removes the attribute schema from this service.
void	removeSubSchema(java.lang.String subSchemaName) Removes the service's sub-schema from the service.
void	setAttributeDefaults(java.util.Map attrs) Method to change the default values of attributes in the schema.
void	setAttributeDefaults(java.lang.String attrName, java.util.Set values) Method to change default value for a specific attribute.
java.lang.String	toString() Returns string represenation of the schema
boolean	validateAttributes(java.util.Map attributeSet) Determines whether each attribute in the attribute set is valid.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getServiceName

public java.lang.String getServiceName()

Returns the name of the service.

Returns:

the name of the schema

getVersion

public java.lang.String getVersion()

Returns the version of the service.

Returns:

version of the service schema

getName

public java.lang.String getName()

Returns the name of the schema.

Returns:

the name of the schema

getServiceType

public SchemaType getServiceType()

Returns the schema tyoe

Returns:

the schema type

getI18NKey

public java.lang.String getI18NKey()

Returns the I18N key that points to the description of the service.

Returns:

the I18N key that points to the description of the service

getPropertiesViewBeanURL

public java.lang.String getPropertiesViewBeanURL()

Returns the view bean URL for this service

Returns:

file name that contains I18N messages

getAttributeSchemaNames

public java.util.Set getAttributeSchemaNames()

Returns the names of the schema attributes defined for the service. It does not return the schema attributes defined for the sub-schema.

Returns:

the names of schema attributes defined for the service

getAttributeSchema

public AttributeSchema getAttributeSchema(java.lang.String attributeName)

Returns the schema for an attribute given the name of the attribute, defined for this service. It returns only the attribute schema defined at the top level for the service and not from the sub-schema.

Parameters:

attributeName - the name of the schema attribute

Returns:

the schema for the attribute

getAttributeSchemas

public java.util.Set getAttributeSchemas()

Returns the attribute schemas defined for the service. It does not return the schema attributes defined for the sub-schema.

Returns:

attribute schemas defined for the service

getServiceAttributeNames

public java.util.Set getServiceAttributeNames()

Returns the attribute schemas defined for the service that is not a status attribute and is not a service attribute. It does not return the schema attributes defined for the sub-schema.

Returns:

attribute schemas defined for the service

addAttributeSchema

public void addAttributeSchema(java.io.InputStream xmlAttrSchema)
                        throws SSOException,
                               SMSException

Adds the attribute schema to this service. The schema is defined in XML inputstream that follows the SMS DTD.

Parameters:

xmlAttrSchema - the XML format of the attribute schema

Throws:

SMSException -

removeAttributeSchema

public void removeAttributeSchema(java.lang.String attrName)
                           throws SSOException,
                                  SMSException

Removes the attribute schema from this service.

Parameters:

attrName - the name of the attribute schema

Throws:

SMSException, - SSOException

getAttributeDefaults

public java.util.Map getAttributeDefaults()

Get a map of all the attribute and their default values in this schema

getReadOnlyAttributeDefaults

public java.util.Map getReadOnlyAttributeDefaults()

Get an unmodifiable map of all the attribute and their default values in this schema.

setAttributeDefaults

public void setAttributeDefaults(java.util.Map attrs)
                          throws SSOException,
                                 SMSException

Method to change the default values of attributes in the schema.

Parameters:

java.util.Map - A map of the names of AttributeSchema to modify, and a Set of Values which should replace the default values of the current schema

Throws:

SchemaException -

com.iplanet.ss.SMSException -

com.iplanet.ss.SSOException -

setAttributeDefaults

public void setAttributeDefaults(java.lang.String attrName,
                                 java.util.Set values)
                          throws SchemaException,
                                 SMSException,
                                 SSOException

Method to change default value for a specific attribute.

Parameters:

java.lang.String - Name of the attribute for which defaults values need to be replaced.

java.util.Set - Set of new values to replace the old ones.

Throws:

SchemaException -

com.iplaner.sm.SMSException -

removeAttributeDefaults

public void removeAttributeDefaults(java.util.Set attrs)
                             throws SMSException,
                                    SSOException

Removes the default values of attributes in the schema.

Parameters:

java.util.Set - A set of the names of AttributeSchema

Throws:

com.iplanet.services.SchemaException -

com.sun.identity.sms.SMSException -

getSubSchemaNames

public java.util.Set getSubSchemaNames()

Returns the names of sub-schemas for the service.

Returns:

the names of service's sub-schemas

getSubSchema

public ServiceSchema getSubSchema(java.lang.String subSchemaName)
                           throws SMSException

Returns ServiceSchema object given the name of the service's sub-schema.

Parameters:

subSchemaName - the name of the service's sub-schema

Returns:

ServiceSchema object

Throws:

SMSException -

addSubSchema

public void addSubSchema(java.io.InputStream xmlSubSchema)
                  throws SSOException,
                         SMSException

Adds the service's sub-schema given the XML inputstream that follows the SMS DTD.

Parameters:

xmlSubSchema - the XML format of the sub-schema

Throws:

SMSException -

removeSubSchema

public void removeSubSchema(java.lang.String subSchemaName)
                     throws SSOException,
                            SMSException

Removes the service's sub-schema from the service.

Parameters:

subSchemaName - the name of the service's sub-schema

Throws:

SMSException -

validateAttributes

public boolean validateAttributes(java.util.Map attributeSet)
                           throws SMSException

Determines whether each attribute in the attribute set is valid. Iterates though the set checking each element to see if there is a validator that needs to execute.

Parameters:

attributeSet - the Map where key is the attribute name and value is the Set of attribute values

Returns:

true if all attributes are valid

Throws:

SMSException -

toString

public java.lang.String toString()

Returns string represenation of the schema

Overrides:

toString in class java.lang.Object

getSchemaNode

public org.w3c.dom.Node getSchemaNode()

Returns the Node of this schema element. Used by Policy component's ServiceType to get ActionSchema.