com.sun.identity.authentication.config

Class AMAuthenticationSchema

java.lang.Object

com.sun.identity.authentication.config.AMAuthenticationSchema

public class AMAuthenticationSchema
extends Object

This class implements a subset of the service schema operations for the AMModule instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AMAuthenticationSchema(ServiceSchema schema)

Method Summary

Modifier and Type	Method and Description
Set	getAttributeNames() Returns a set of all the attribute names.
AttributeSchema	getAttributeSchema(String attr) Returns an AttributeSchema of the specified attribute name.
Set	getAttributeSchemas() Returns a Set which contains all the AttributeSchemas.
Map	getAttributeValues() Returns the default values for all the attributes.
Map	getAttributeValues(Set names) Returns the default values for the specified attributes.
String	getName() Returns the name of this schema.
Set	getRequiredAttributeNames() Returns a set of required attribute names.
String	getServiceName() Returns the name of the service schema.
void	setAttribute(String attrName, Set values) Sets default value for a specific attribute.
void	setAttributeValues(Map values) Sets the default attribute values.

Methods inherited from class java.lang.Object

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

Constructor Detail

AMAuthenticationSchema

protected AMAuthenticationSchema(ServiceSchema schema)

Method Detail

getName

public String getName()

Returns the name of this schema.

Returns:

a String value of the schema name.

getServiceName

public String getServiceName()

Returns the name of the service schema.

Returns:

the name of the service schema.

getRequiredAttributeNames

public Set getRequiredAttributeNames()

Returns a set of required attribute names.

Returns:

a Set of the required attribute names of the subject schema.

getAttributeNames

public Set getAttributeNames()

Returns a set of all the attribute names.

Returns:

a Set of all the attribute names.

getAttributeSchema

public AttributeSchema getAttributeSchema(String attr)

Returns an AttributeSchema of the specified attribute name.

Parameters:

attr - the specified attribute name.

Returns:

the AttributeSchema of the attribute.

getAttributeSchemas

public Set getAttributeSchemas()

Returns a Set which contains all the AttributeSchemas.

Returns:

Set of AttributeSchema.

getAttributeValues

public Map getAttributeValues()

Returns the default values for all the attributes.

Returns:

a Map that contains all the default attributes and their values.

getAttributeValues

public Map getAttributeValues(Set names)

Returns the default values for the specified attributes.

Parameters:

names - a Set of attribute names in String values.

Returns:

a Map that contains all the default attributes and their values for the specified attributes.

setAttributeValues

public void setAttributeValues(Map values)
                        throws SchemaException,
                               SMSException,
                               SSOException

Sets the default attribute values.

Parameters:

values - 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

SMSException - if an error occurred while performing the operation

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

setAttribute

public void setAttribute(String attrName,
                         Set values)
                  throws SchemaException,
                         SMSException,
                         SSOException

Sets 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:

SchemaException - if an error occurred while parsing the XML

SMSException - if an error occurred while performing the operation

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