Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.iplanet.am.sdk
Class AMAttributeSchema

java.lang.Object
  |
  +--com.iplanet.am.sdk.AMAttributeSchema
Deprecated. This class has been deprecated. Please use com.sun.identity.sm.AttributeSchema.

public class AMAttributeSchema
extends java.lang.Object

The class AMAttributeSchema provides the interfaces to obtain meta information about service configuration variable.

Field Summary
static int SYNTAX_BOOLEAN
          Deprecated. The SYNTAX_BOOLEAN attribute syntax specifies that the attribute is of boolean type, i.e., can have a value of either true or false
static int SYNTAX_DATE
          Deprecated. The SYNTAX_DATE attribute syntax specifies that the attribute should be a date
static int SYNTAX_DECIMAL_NUMBER
          Deprecated. The SYNTAX_DECIMAL_NUMBER attribute syntax specifies that the attribute is a floating point number, e.g., 1.5, 3.56, etc.
static int SYNTAX_DECIMAL_RANGE
          Deprecated. The SYNTAX_DECIMAL_RANGE attribute syntax specifies that the attribute is a decimal number within a range.
static int SYNTAX_DN
          Deprecated. The SYNTAX_DN attribute syntax specifies that the attribute should be an LDAP distinguished name (DN).
static int SYNTAX_EMAIL
          Deprecated. The SYNTAX_EMAIL attribute syntax specifies that the attribute is a email address.
static int SYNTAX_ENCRYPTED_PASSWORD
          Deprecated. The SYNTAX_ENCRYPTED_PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.
static int SYNTAX_NUMBER
          Deprecated. The SYNTAX_NUMBER attribute syntax specifies that the attribute is a number.
static int SYNTAX_NUMBER_RANGE
          Deprecated. The SYNTAX_NUMBER_RANGE attribute syntax specifies that the attribute is a number within a range.
static int SYNTAX_NUMERIC
          Deprecated. The SYNTAX_NUMERIC attribute syntax specifies that the attribute is numeric, i.e., can have numbers only.
static int SYNTAX_PARAGRAPH
          Deprecated. The SYNTAX_PARAGRAPH attribute syntax specifies that the attribute should be a paragraph
static int SYNTAX_PASSWORD
          Deprecated. The SYNTAX_PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.
static int SYNTAX_PERCENT
          Deprecated. The SYNTAX_PERCENT attribute syntax specifies that the attribute is a percentage.
static int SYNTAX_STRING
          Deprecated. The SYNTAX_STRING attribute syntax specifies that the attribute is of text type, i.e., can have any unicode characters
static int SYNTAX_URL
          Deprecated. The SYNTAX_URL attribute syntax specifies that the attribute is a URL.
static int SYNTAX_XML
          Deprecated. The SYNTAX_XML attribute syntax specifies that the attribute should be a XML blob
static int TYPE_LIST
          Deprecated. The TYPE_LIST attribute type specifies that the attribute can have multiple values, i.e., multi-valued attribute
static int TYPE_MULTIPLE_CHOICE
          Deprecated. The TYPE_MULTIPLE_CHOICE attribute type specifies that the attribute can have multiple values defined by the getChoiceValues method of AMAttributeSchema.
static int TYPE_SIGNATURE
          Deprecated. The TYPE_SIGNATURE attribute type specifies that the attribute is a signing attribute.
static int TYPE_SINGLE
          Deprecated. The TYPE_SINGLE attribute type specifies that the attribute can have only a single value
static int TYPE_SINGLE_CHOICE
          Deprecated. The TYPE_SINGLE_CHOICE attribute type specifies that the attribute can have value defined by the getChoiceValues method of AMAttributeSchema.
static int TYPE_VALIDATOR
          Deprecated. The VALIDATOR attribute type specifies that the attribute defines a attribute validator plugin.
static int UITYPE_BUTTON
          Deprecated. The UITYPE_BUTTON attribute type specifies that the attribute should be display as a button.
static int UITYPE_LINK
          Deprecated. The UITYPE_LINK attribute type specifies that the attribute should be display as a link.
static int UITYPE_RADIO
          Deprecated. The UITYPE_RADIO attribute type specifies that the attribute should be display as a radio button.
static int UITYPE_UNDEFINED
          Deprecated. The UITYPE_UNDEFINED attribute type specifies that the UI type is not defined.
 
Method Summary
 java.lang.String getAny()
          Deprecated. Method to get service specific attributes.
 java.lang.String getChoiceValueI18NKey(java.lang.String cValue)
          Deprecated. Given a choice value, this method returns the i18nKey for that choice value
 java.lang.String[] getChoiceValues()
          Deprecated. If the attribute is of choice type, this method returns the possible values for the attribute; null otherwise
 java.lang.String getCosQualifier()
          Deprecated. Returns the value of the cosQualifier for this attribute that is default or merge-schemes.
 java.util.Set getDefaultValues()
          Deprecated. The method returns the default value of the attribute;
 java.lang.String getEndRange()
          Deprecated. Method to get ending range for possible values of the attribute
 java.lang.String getFalseValue()
          Deprecated. Method to get string value for "FALSE"
 java.lang.String getFalseValueI18NKey()
          Deprecated. Method to get the i18n Key for BooleanFalseValue.
 java.lang.String getI18NKey()
          Deprecated. Returns I18N key to describe the configuration attribute.
 java.lang.String getName()
          Deprecated. The method returns the name of the attribute
 java.lang.String getPropertiesViewBeanURL()
          Deprecated. Returns URL of the view bean for the attribute.
 java.lang.String getStartRange()
          Deprecated. Method to get starting range for possible values of the attribute
 int getSyntax()
          Deprecated. The method returns the syntax of the attribute i.e., string, boolean, distinguished name (String), numeric.
 java.lang.String getTrueValue()
          Deprecated. Method to get the string value for "TRUE"
 java.lang.String getTrueValueI18NKey()
          Deprecated. Method to get the i18n Key for BooleanTrueValue.
 int getType()
          Deprecated. The method returns the type of the attribute i.e., single, list or choice
 int getUIType()
          Deprecated. The method returns the UI type of the attribute i.e., link, button, ...
 void setI18NKey(java.lang.String i18nKey)
          Deprecated. Set I18N key to describe the configuration attribute
 java.lang.String toString()
          Deprecated. Method that returns the String representation of the AMAttributeSchema.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_SINGLE

public static final int TYPE_SINGLE
Deprecated. 
The TYPE_SINGLE attribute type specifies that the attribute can have only a single value

TYPE_LIST

public static final int TYPE_LIST
Deprecated. 
The TYPE_LIST attribute type specifies that the attribute can have multiple values, i.e., multi-valued attribute

TYPE_SINGLE_CHOICE

public static final int TYPE_SINGLE_CHOICE
Deprecated. 
The TYPE_SINGLE_CHOICE attribute type specifies that the attribute can have value defined by the getChoiceValues method of AMAttributeSchema.

TYPE_MULTIPLE_CHOICE

public static final int TYPE_MULTIPLE_CHOICE
Deprecated. 
The TYPE_MULTIPLE_CHOICE attribute type specifies that the attribute can have multiple values defined by the getChoiceValues method of AMAttributeSchema.

TYPE_SIGNATURE

public static final int TYPE_SIGNATURE
Deprecated. 
The TYPE_SIGNATURE attribute type specifies that the attribute is a signing attribute.

TYPE_VALIDATOR

public static final int TYPE_VALIDATOR
Deprecated. 
The VALIDATOR attribute type specifies that the attribute defines a attribute validator plugin.

UITYPE_RADIO

public static final int UITYPE_RADIO
Deprecated. 
The UITYPE_RADIO attribute type specifies that the attribute should be display as a radio button.

UITYPE_LINK

public static final int UITYPE_LINK
Deprecated. 
The UITYPE_LINK attribute type specifies that the attribute should be display as a link.

UITYPE_BUTTON

public static final int UITYPE_BUTTON
Deprecated. 
The UITYPE_BUTTON attribute type specifies that the attribute should be display as a button.

UITYPE_UNDEFINED

public static final int UITYPE_UNDEFINED
Deprecated. 
The UITYPE_UNDEFINED attribute type specifies that the UI type is not defined.

SYNTAX_BOOLEAN

public static final int SYNTAX_BOOLEAN
Deprecated. 
The SYNTAX_BOOLEAN attribute syntax specifies that the attribute is of boolean type, i.e., can have a value of either true or false

SYNTAX_EMAIL

public static final int SYNTAX_EMAIL
Deprecated. 
The SYNTAX_EMAIL attribute syntax specifies that the attribute is a email address.

SYNTAX_URL

public static final int SYNTAX_URL
Deprecated. 
The SYNTAX_URL attribute syntax specifies that the attribute is a URL.

SYNTAX_STRING

public static final int SYNTAX_STRING
Deprecated. 
The SYNTAX_STRING attribute syntax specifies that the attribute is of text type, i.e., can have any unicode characters

SYNTAX_PASSWORD

public static final int SYNTAX_PASSWORD
Deprecated. 
The SYNTAX_PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.

SYNTAX_NUMERIC

public static final int SYNTAX_NUMERIC
Deprecated. 
The SYNTAX_NUMERIC attribute syntax specifies that the attribute is numeric, i.e., can have numbers only.

SYNTAX_NUMBER

public static final int SYNTAX_NUMBER
Deprecated. 
The SYNTAX_NUMBER attribute syntax specifies that the attribute is a number.

SYNTAX_PERCENT

public static final int SYNTAX_PERCENT
Deprecated. 
The SYNTAX_PERCENT attribute syntax specifies that the attribute is a percentage.

SYNTAX_NUMBER_RANGE

public static final int SYNTAX_NUMBER_RANGE
Deprecated. 
The SYNTAX_NUMBER_RANGE attribute syntax specifies that the attribute is a number within a range.

SYNTAX_DECIMAL_RANGE

public static final int SYNTAX_DECIMAL_RANGE
Deprecated. 
The SYNTAX_DECIMAL_RANGE attribute syntax specifies that the attribute is a decimal number within a range.

SYNTAX_DECIMAL_NUMBER

public static final int SYNTAX_DECIMAL_NUMBER
Deprecated. 
The SYNTAX_DECIMAL_NUMBER attribute syntax specifies that the attribute is a floating point number, e.g., 1.5, 3.56, etc.

SYNTAX_DN

public static final int SYNTAX_DN
Deprecated. 
The SYNTAX_DN attribute syntax specifies that the attribute should be an LDAP distinguished name (DN).

SYNTAX_PARAGRAPH

public static final int SYNTAX_PARAGRAPH
Deprecated. 
The SYNTAX_PARAGRAPH attribute syntax specifies that the attribute should be a paragraph

SYNTAX_DATE

public static final int SYNTAX_DATE
Deprecated. 
The SYNTAX_DATE attribute syntax specifies that the attribute should be a date

SYNTAX_XML

public static final int SYNTAX_XML
Deprecated. 
The SYNTAX_XML attribute syntax specifies that the attribute should be a XML blob

SYNTAX_ENCRYPTED_PASSWORD

public static final int SYNTAX_ENCRYPTED_PASSWORD
Deprecated. 
The SYNTAX_ENCRYPTED_PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.
Method Detail

getName

public java.lang.String getName()
Deprecated. 
The method returns the name of the attribute
Returns:
name of the attribute

getType

public int getType()
Deprecated. 
The method returns the type of the attribute i.e., single, list or choice
Returns:
the type of the attribute.

getUIType

public int getUIType()
Deprecated. 
The method returns the UI type of the attribute i.e., link, button, ...
Returns:
the UI type of the attribute; UITYPE_UNDEFINED if the UI type is not defined for the attribute

getSyntax

public int getSyntax()
Deprecated. 
The method returns the syntax of the attribute i.e., string, boolean, distinguished name (String), numeric.
Returns:
syntax of the attribute

getCosQualifier

public java.lang.String getCosQualifier()
Deprecated. 
Returns the value of the cosQualifier for this attribute that is default or merge-schemes.
Returns:
String value of cosQualifier.

getDefaultValues

public java.util.Set getDefaultValues()
Deprecated. 
The method returns the default value of the attribute;
Returns:
Set containing the default values of the attribute or Collections.EMPTY_SET otherwise

getChoiceValues

public java.lang.String[] getChoiceValues()
Deprecated. 
If the attribute is of choice type, this method returns the possible values for the attribute; null otherwise
Returns:
String array of possible choice values; null otherwise

getChoiceValueI18NKey

public java.lang.String getChoiceValueI18NKey(java.lang.String cValue)
Deprecated. 
Given a choice value, this method returns the i18nKey for that choice value
Parameters:
cValue - the choice value
Returns:
the i18N key corresponding to the choice value

getI18NKey

public java.lang.String getI18NKey()
Deprecated. 
Returns I18N key to describe the configuration attribute.
Returns:
i18n index key to the resource bundle

setI18NKey

public void setI18NKey(java.lang.String i18nKey)
                throws AMException
Deprecated. 
Set I18N key to describe the configuration attribute
Parameters:
i18nKey - value of i18nKey.
Throws:
AMException -  

getStartRange

public java.lang.String getStartRange()
Deprecated. 
Method to get starting range for possible values of the attribute
Returns:
starting range for the attribute value

getEndRange

public java.lang.String getEndRange()
Deprecated. 
Method to get ending range for possible values of the attribute
Returns:
ending range for the attribute value

getAny

public java.lang.String getAny()
Deprecated. 
Method to get service specific attributes. It return the value of the "any" attribute, if set in the XML schema for the service
Returns:
value of "any" attribute

getPropertiesViewBeanURL

public java.lang.String getPropertiesViewBeanURL()
Deprecated. 
Returns URL of the view bean for the attribute.
Returns:
URL for view bean

getTrueValue

public java.lang.String getTrueValue()
Deprecated. 
Method to get the string value for "TRUE"
Returns:
String for TRUE value

getTrueValueI18NKey

public java.lang.String getTrueValueI18NKey()
Deprecated. 
Method to get the i18n Key for BooleanTrueValue.
Returns:
String i18nKey for TRUE value

getFalseValue

public java.lang.String getFalseValue()
Deprecated. 
Method to get string value for "FALSE"
Returns:
String for FALSE value

getFalseValueI18NKey

public java.lang.String getFalseValueI18NKey()
Deprecated. 
Method to get the i18n Key for BooleanFalseValue.
Returns:
String i18nKey for FALSE value.

toString

public java.lang.String toString()
Deprecated. 
Method that returns the String representation of the AMAttributeSchema.
Overrides:
toString in class java.lang.Object
Returns:
String representation of the AMAttributeSchema/
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD