com.iplanet.am.sdk
Class AMSchema

java.lang.Object
  |
  +--com.iplanet.am.sdk.AMSchema

Deprecated. This class has been deprecated. Please use com.sun.identity.sm.ServiceSchema.

public class AMSchema

extends java.lang.Object

The class AMSchema provides interfaces to get the schema information for service configuration information

Inner Class Summary

static class

AMSchema.Type Deprecated. This class has been deprecated. Please use com.sun.identity.sm.SchemaType.

Method Summary

static void	addListener(java.lang.String serviceName, AMServiceListener listener) Deprecated. Registers the listener for the given service name
java.util.Map	getAttributeDefaults() Deprecated. Get a map of all the attribute and their default values in this schema
java.util.Set	getAttributeNames() Deprecated. Method to obtain the names of the schema attributes defined for the service.
AMAttributeSchema	getAttributeSchema(java.lang.String attributeName) Deprecated. Method to obtain the schema for an attribute given the name of the attribute, defined for this service.
java.util.Set	getAttributeSchemas() Deprecated. Get all the AMAttributeSchema defined for this Service Schema.
java.lang.String	getI18NKey() Deprecated. Method to get I18N key to describe the service
java.lang.String	getPropertiesViewBeanURL() Deprecated. gets properties view bean associated with this schema
java.util.Map	getReadOnlyAttributeDefaults() Deprecated. Get an unmodifiable map of all the attribute and their default values in this schema
AMSchema.Type	getSchemaType() Deprecated. Method to obtain the schema type.
java.lang.String	getServiceName() Deprecated. Method to obtain the service name.
java.lang.String	getStatusAttribute() Deprecated. Method to get the name of the service status attribute.
java.lang.String[]	getStatusAttributeChoiceValues() Deprecated. Method to get the choice values for the status attribute of this service (and this schema)
AMSchema	getSubSchema(java.lang.String subSchemaName) Deprecated. Method to obtain Service SubSchema object given the name of the service's sub schema.
java.util.Set	getSubSchemaNames() Deprecated. Method to get the names of sub-schemas names for the this Schema
void	removeAttributeDefaults(java.util.Set attrs) Deprecated. Method to remove default values of attributes in the schema.
static void	removeListener(java.lang.String serviceName, AMServiceListener listener) Deprecated. Unregisters the listener for the given service name
void	setAttributeDefaults(java.util.Map attrs) Deprecated. Method to change the default values of attributes in the schema.
void	setAttributeDefaults(java.lang.String attrName, java.util.Set values) Deprecated. Method to change default value for a specific attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getServiceName

public java.lang.String getServiceName()

Deprecated.

Method to obtain the service name.

Returns:

name of the service

getSchemaType

public AMSchema.Type getSchemaType()

Deprecated.

Method to obtain the schema type.

Returns:

schema type (AMSchema.Type.DYNAMIC, AMSchema.Type.POLICY, AMSchema.Type.ORGANIZATION or AMSchema.Type.USER).

getI18NKey

public java.lang.String getI18NKey()

Deprecated.

Method to get I18N key to describe the service

Returns:

i18n index key to the resource bundle

getStatusAttribute

public java.lang.String getStatusAttribute()

Deprecated.

Method to get the name of the service status attribute.

Returns:

status Attribute name

getStatusAttributeChoiceValues

public java.lang.String[] getStatusAttributeChoiceValues()

Deprecated.

Method to get the choice values for the status attribute of this service (and this schema)

Returns:

String[] array of strings.

getAttributeNames

public java.util.Set getAttributeNames()

Deprecated.

Method to obtain the names of the schema attributes defined for the service. It does not return the schema attributes defined for sub-services.

Returns:

names of schema attributes defined for the service

getAttributeSchema

public AMAttributeSchema getAttributeSchema(java.lang.String attributeName)

Deprecated.

Method to obtain 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 attribute name

Returns:

schema for the attribute or null if the no schema exists for the given attribute name

getAttributeSchemas

public java.util.Set getAttributeSchemas()

Deprecated.

Get all the AMAttributeSchema defined for this Service Schema.

Returns:

Set of AMAttributeSchema defined in this Schema.

getAttributeDefaults

public java.util.Map getAttributeDefaults()

Deprecated.

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

Returns:

Map of Attribute Names and Sets of their default values as defined in the Schema

getReadOnlyAttributeDefaults

public java.util.Map getReadOnlyAttributeDefaults()

Deprecated.

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

Returns:

Unmodifiable Map of Attribute Names and unmodifiable Sets of their default values as defined in the Schema

getSubSchemaNames

public java.util.Set getSubSchemaNames()

Deprecated.

Method to get the names of sub-schemas names for the this Schema

Returns:

names of service's sub-schema

getSubSchema

public AMSchema getSubSchema(java.lang.String subSchemaName)
                      throws AMException

Deprecated.

Method to obtain Service SubSchema object given the name of the service's sub schema.

Parameters:

subSchemaName - name of the service's sub schema

Returns:

service's sub schema object

Throws:

AMException -

setAttributeDefaults

public void setAttributeDefaults(java.util.Map attrs)
                          throws AMException

Deprecated.

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

Parameters:

attrs - A map of the names of attribute schema to modify, and a Set of Values which should replace the default values of the current schema.

Throws:

AMException -

setAttributeDefaults

public void setAttributeDefaults(java.lang.String attrName,
                                 java.util.Set values)
                          throws AMException

Deprecated.

Method to change default value for a specific attribute.

Parameters:

attrName - Name of the attribute for which defaults values need to be replaced.

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

Throws:

AMException - if unable to access/modify the data store due to an error

removeAttributeDefaults

public void removeAttributeDefaults(java.util.Set attrs)
                             throws AMException

Deprecated.

Method to remove default values of attributes in the schema.

Parameters:

attrs - A set of the names of attribute

Throws:

AMException - if unable to access/modify the data store due to an error

getPropertiesViewBeanURL

public java.lang.String getPropertiesViewBeanURL()

Deprecated.

gets properties view bean associated with this schema

Returns:

properties view bean URL

addListener

public static void addListener(java.lang.String serviceName,
                               AMServiceListener listener)
                        throws AMException

Deprecated.

Registers the listener for the given service name

Parameters:

serviceName - the name of the service

listener - the service listener

Throws:

AMException - if an error is encountered in registering the listener

removeListener

public static void removeListener(java.lang.String serviceName,
                                  AMServiceListener listener)
                           throws AMException

Deprecated.

Unregisters the listener for the given service name

Parameters:

serviceName - the name of the service.

listener - the listener registration ID.

Throws:

AMException - if an error is encountered in unregistering the listener